kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-07-01 05:23:25 +00:00
Code Issues Projects Releases Wiki Activity

Add readme.

Browse Source
This commit is contained in:
Michael Teeuw 2017-09-22 10:37:39 +02:00
parent ef172592b8
commit 5b1462a3e8
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
modules/default/weather/README.md Normal file
View File

@ -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