MagicMirror/README.md

# MagicMirror V2
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.

##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.

##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).


##Modules 

### Default modules
##### Clock
##### Current Weather
##### Weather Forecast
##### News Feed
##### Compliments
##### Hello World

### 3rd Party 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)
Initial version of the README. 2016-03-27 16:57:20 +02:00			`# MagicMirror V2`
Updated README 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.`

Add configuration instructions and todo. 2016-03-29 13:35:55 +02:00			`#WARNING: THIS VERSION IS IN A VERY EARLY STAGE. IT IS NOT COMPLETED YET. PLEASE USE THE MASTER BRANCH.`

Updated README 2016-03-28 13:47:40 +02:00			`##Usage`
			`1. Install [Node.js](https://nodejs.org/en/)`
			2. Execute `npm install && npm start`.

Add configuration instructions and todo. 2016-03-29 13:35:55 +02:00			`##Configuration`
			1. Duplicate `config/config.js.sample` to `config/config.js`.
			`2. Modify your required settings.`

Updated README 2016-03-28 13:47:40 +02:00			`##Todo`
			`Things that still have to be implemented or changed.`
Add module info to readme. 2016-03-30 15:20:14 +02:00
Add configuration instructions and todo. 2016-03-29 13:35:55 +02:00			`####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).

Add module info to readme. 2016-03-30 15:20:14 +02:00
Added Callmonitor to README 2016-03-30 15:13:46 +02:00			`##Modules`

Add module info to readme. 2016-03-30 15:20:14 +02:00			`### Default modules`
			`##### Clock`
			`##### Current Weather`
			`##### Weather Forecast`
			`##### News Feed`
			`##### Compliments`
			`##### Hello World`

			`### 3rd Party Modules`

			`#####[MMM-FRITZ-Box-Callmonitor by PaViRo](https://github.com/paviro/MMM-FRITZ-Box-Callmonitor)`
Added Callmonitor to README 2016-03-30 15:13:46 +02:00			`Features: FRITZ!Box Callmonitor (displays alert when someone is calling)`

Add module info to readme. 2016-03-30 15:20:14 +02:00
Add server (web/socket), create socket system, better helper loader. - The Magic Mirror is now hosted via a express server, allowing you to load it from an external client (for debugging.) - It now includes a socket system to communicate between the node_helper and the client module. - node_helpers are now only loaded if the module is configured in the config. 2016-03-30 12:20:46 +02:00
Initial version of the README. 2016-03-27 16:57:20 +02:00
Add configuration instructions and todo. 2016-03-29 13:35:55 +02:00