diff --git a/.github/header.png b/.github/header.png new file mode 100644 index 00000000..c2e5769c Binary files /dev/null and b/.github/header.png differ diff --git a/.github/header.psd b/.github/header.psd new file mode 100644 index 00000000..edb90260 Binary files /dev/null and b/.github/header.psd differ diff --git a/README.md b/README.md index cbfac2d0..6b67f380 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ -# MagicMirror² +![MagicMirror²: The open source modular Smart Mirror platform. ](.github/header.png) + [![Dependency Status](https://david-dm.org/MichMich/MagicMirror/v2-beta.svg)](https://david-dm.org/MichMich/MagicMirror/v2-beta) [![devDependency Status](https://david-dm.org/MichMich/MagicMirror/v2-beta/dev-status.svg)](https://david-dm.org/MichMich/MagicMirror/v2-beta#info=devDependencies) [![Node Version](https://img.shields.io/badge/node-v5.10.1-brightgreen.svg)](https://nodejs.org/dist/latest) + This version of the Magic Mirror software focusses on a modular plugin system. Besides that, the MagicMirror² 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. @@ -38,6 +40,12 @@ 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. + +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) + ## Configuration 1. Duplicate `config/config.js.sample` to `config/config.js`.