From 3543ebb9a623f323660fd1e32aa4a769b83f8002 Mon Sep 17 00:00:00 2001 From: Michael Teeuw Date: Mon, 11 Apr 2016 11:27:44 +0200 Subject: [PATCH] Add project description. Remove TODO's. --- README.md | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index cb8047dd..b7d8717d 100644 --- a/README.md +++ b/README.md @@ -7,17 +7,17 @@ License

+**MagicMirror²** is an open source modular smart mirror platform. With a growing list of installable modules, the **MagicMirror²** allows you to convert your hallway or bathroom mirror into your personal assistant. **MagicMirror²** is built by the creator of [the original MagicMirror](http://michaelteeuw.nl/tagged/magicmirror) with the incredible help of a [growing community of contributors](https://github.com/MichMich/MagicMirror/graphs/contributors). -This version of the Magic Mirror software focuses on a modular plugin system. Besides that, the MagicMirror² software now also uses [Electron](http://electron.atom.io/), so no more web server or browser installs necessary. +MagicMirror² focuses on a modular plugin system and uses [Electron](http://electron.atom.io/) as an application wrapper. So no more web server or browser installs necessary! -**WARNING!** This version is in a *very* early stage. It is **not** completed yet. **Please** use the master branch. +**WARNING!** This version is in a early stage. It is **not** completed yet. **Please** use the master branch. ## Table Of Contents - [Usage](#usage) - [Configuration](#configuration) - [Modules](#modules) -- [Todo List](#todo-list) - [Contributing Guidelines](#contributing-guidelines) ## Usage @@ -42,11 +42,11 @@ curl -sL https://raw.githubusercontent.com/MichMich/MagicMirror/v2-beta/installe In some cases, you want to start the application without an actual app window. In this case, exectute the following command from the MagicMirror folder: `node serveronly`. This will start the server, after which you can open the application in your browser of choice. -#### Auto Start & Raspberry Configuration. +#### Raspberry Configuration & Auto Start. The following wiki links are helpful in the cofiguration of your MagicMirror² operating system: -- [Auto Starting MagicMirror](https://github.com/MichMich/MagicMirror/wiki/Auto-Starting-MagicMirror) - [Configuring the Raspberry Pi](https://github.com/MichMich/MagicMirror/wiki/Configuring-the-Raspberry-Pi) +- [Auto Starting MagicMirror](https://github.com/MichMich/MagicMirror/wiki/Auto-Starting-MagicMirror) ## Configuration @@ -98,14 +98,6 @@ The following modules are created by their respective authors. **Note:** If you want to build your own modules, check out the [MagicMirror² Module Development Documentation](modules) -## Todo List - -Here is a list of various things that still have to be implemented or changed. - -- [ ] Allow show/hide animations to animate the height. This way, the other modules won't jump around. -- [ ] Allow vertical centering of alerts. -- [ ] Write all the documentation. - ## Contributing Guidelines Contributions of all kinds are welcome, not only in the form of code but also with regards bug reports and documentation.