From e98f5fdd4c3d09476ff763ce912102c0ff07086a Mon Sep 17 00:00:00 2001 From: Matthias Kleine Date: Thu, 7 Jul 2022 08:14:58 +0200 Subject: [PATCH] Documentation and README --- LICENSE | 1 + README.md | 5 +++-- docs/de/{pvforecast.md => README.md} | 0 docs/en/{pvforecast.md => README.md} | 0 io-package.json | 4 ++-- 5 files changed, 6 insertions(+), 4 deletions(-) rename docs/de/{pvforecast.md => README.md} (100%) rename docs/en/{pvforecast.md => README.md} (100%) diff --git a/LICENSE b/LICENSE index f97a677..72d8fa4 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,7 @@ MIT License Copyright (c) 2022 Patrick-Walther + Matthias Kleine Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 4f80905..a0ba37e 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,9 @@ Provides forecast data from [forecast.solar](https://forecast.solar) or [Solcast ## Documentation -[πŸ‡ΊπŸ‡Έ Documentation](./docs/en/pvforecast.md) +[πŸ‡ΊπŸ‡Έ Documentation](./docs/en/README.md) -[πŸ‡©πŸ‡ͺ Dokumentation](./docs/de/pvforecast.md) +[πŸ‡©πŸ‡ͺ Dokumentation](./docs/de/README.md) ## Credits @@ -67,6 +67,7 @@ Provides forecast data from [forecast.solar](https://forecast.solar) or [Solcast MIT License Copyright (c) 2022 Patrick-Walther + Matthias Kleine Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/docs/de/pvforecast.md b/docs/de/README.md similarity index 100% rename from docs/de/pvforecast.md rename to docs/de/README.md diff --git a/docs/en/pvforecast.md b/docs/en/README.md similarity index 100% rename from docs/en/pvforecast.md rename to docs/en/README.md diff --git a/io-package.json b/io-package.json index 85c52c0..ec12ab7 100644 --- a/io-package.json +++ b/io-package.json @@ -118,11 +118,11 @@ ], "docs": { "en": [ - "docs/en/pvforecast.md", + "docs/en/README.md", "docs/en/vis.md" ], "de": [ - "docs/de/pvforecast.md", + "docs/de/README.md", "docs/de/vis.md" ] },