MagicMirror/README.md

29 lines
1.1 KiB
Markdown
Raw Normal View History

2016-03-27 16:57:20 +02:00
# MagicMirror V2
2016-03-28 13:47:40 +02:00
This version of the Magic Mirror software focusses on a modular plugin system. Besides that, the Magic Mirror software now also uses [Electron](http://electron.atom.io/), so no more webserver or browser installs necessary.
#WARNING: THIS VERSION IS IN A VERY EARLY STAGE. IT IS NOT COMPLETED YET. PLEASE USE THE MASTER BRANCH.
2016-03-28 13:47:40 +02:00
##Usage
1. Install [Node.js](https://nodejs.org/en/)
2. Execute `npm install && npm start`.
##Configuration
1. Duplicate `config/config.js.sample` to `config/config.js`.
2. Modify your required settings.
2016-03-28 13:47:40 +02:00
##Todo
Things that still have to be implemented or changed.
####Loader
- Loading of module uses `eval()`. We might want to look into a better solution. [loader.js#L112](https://github.com/MichMich/MagicMirror/blob/v2-beta/js/loader.js#L112).
2016-03-30 15:13:46 +02:00
##Modules
###[MMM-FRITZ-Box-Callmonitor by PaViRo](https://github.com/paviro/MMM-FRITZ-Box-Callmonitor)
**Features:** FRITZ!Box Callmonitor (displays alert when someone is calling)
2016-03-30 14:49:37 +02:00
####NodeHelper
- The node_helper superclass creates a seperate socket connection for each module. It's preferred to use the overall socket connection of the server.
2016-03-27 16:57:20 +02:00