kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-06-27 11:50:00 +00:00
Code Issues Projects Releases Wiki Activity

Update readme.md

Browse Source
This commit is contained in:
Michael Teeuw 2015-10-30 12:36:41 +01:00
commit a00da4e40c
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,14 +1,19 @@
MagicMirror MagicMirror
=========== ===========
##Configuration ##Introduction
The super magic interface of my personal Magic Mirror. More information about this project can be found on my [blog](http://michaelteeuw.nl/tagged/magicmirror). The super magic interface of my personal Magic Mirror. More information about this project can be found on my [blog](http://michaelteeuw.nl/tagged/magicmirror).
Runs as a php script on a web server with basically no external dependencies. Can use socket.io for XBEE integration, but isn't required for basic functionality. Runs as a php script on a web server with basically no external dependencies. Can use socket.io for XBEE integration, but isn't required for basic functionality.
##Configuration
Modify js/config.js to change some general variables (language, wather location, compliments, news feed RSS) and calendar.php to add your own ICS calendar Modify js/config.js to change some general variables (language, wather location, compliments, news feed RSS) and calendar.php to add your own ICS calendar
To use the OpenWeatherMap API, you'll need a free API key. Checkout [this blogpost](http://michaelteeuw.nl/post/131504229357/what-happened-to-the-weather) for more information.
##Code ##Code
###[main.js](js/main.js) ###[main.js](js/main.js)
@ -29,7 +34,7 @@ Takes an array of news feeds (or a single string) from the config file and retri
###[Time](js/time) ###[Time](js/time)
Updates the time on the screen on one second interval (I think). Updates the time on the screen on one second interval.
###[Version](js/version) ###[Version](js/version)
@ -37,4 +42,6 @@ Checks the git version and refreshes if a new version has been pulled.
###[Weather](js/weather) ###[Weather](js/weather)
Takes the user's inserted location, language, unit type, and OpenWeatherMap API key and grabs the five day weather forecast from OpenWeatherMap. Takes the user's inserted location, language, unit type, and OpenWeatherMap API key and grabs the five day weather forecast from OpenWeatherMap. You need to set the API key in the config for this to work. (See *configuration*.)