From 2a41e55ff23a3e09697e3f523ad075d30929ea51 Mon Sep 17 00:00:00 2001 From: Paul-Vincent Roll Date: Mon, 28 Mar 2016 13:47:40 +0200 Subject: [PATCH] Updated README --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 84fb123b..33bc3757 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ # MagicMirror V2 -This version of the Magic Mirror software focusses on a modular plugin system. -To start the software run `npm install && npm start`. +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. + +##Usage +1. Install [Node.js](https://nodejs.org/en/) +2. Execute `npm install && npm start`. + +##Todo +Things that still have to be implemented or changed. +###Helper scripts +- Only start helper scripts of modules that are actually loaded in the UI (config.js) +- Notification system, so that not every helper scripts needs it's own socket to the UI. #WARNING: THIS VERSION IS IN A VERY EARLY STAGE. IT IS NOT COMPLETED YET. PLEASE USE THE MASTER BRANCH.