From 5b1462a3e878fac01ba930cb1c934ac77456a3f2 Mon Sep 17 00:00:00 2001 From: Michael Teeuw Date: Fri, 22 Sep 2017 10:37:39 +0200 Subject: [PATCH] Add readme. --- modules/default/weather/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 modules/default/weather/README.md diff --git a/modules/default/weather/README.md b/modules/default/weather/README.md new file mode 100644 index 00000000..325732cc --- /dev/null +++ b/modules/default/weather/README.md @@ -0,0 +1,17 @@ +# Weather Module + +This module is aimed to be the replacement for the current `currentweather` and `weatherforcast` modules. The module will be configurable to be used as a current weather view, or to show the forecast. This way the module can be used twice to fullfil both purposes. + +The biggest cange is the use of weather providers. This way we are not bound to one API source. And users can choose which API they want to use as their source. Initially the current OpenWeatherMap will be added as the first source, but more will follow soon. + +The module is in a very early stage, and needs a lot of work. It's API isn't set in stone, so keep that in mind when you want to contribute. + +## TODO + +- [ ] Add Current Weather View +- [ ] Add Weather Forecast View +- [ ] Add Forecast API Call +- [ ] Add all original configuration options +- [ ] Add more providers +- [ ] Finish thi Todo list +- [ ] Write the documentation \ No newline at end of file