diff --git a/README.md b/README.md index c01cb2aa..2a2c898b 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,18 @@ [](https://david-dm.org/MichMich/MagicMirror/v2-beta) [](https://david-dm.org/MichMich/MagicMirror/v2-beta#info=devDependencies) -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. +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. +## Table of contents + +- [Usage](#usage) +- [Configuration](#configuration) +- [Modules](#modules) +- [Todo List](#todo-list) +- [Contributing Guidelines](#contributing-guidelines) + ## Usage #### Automatic Installer (Raspberry Pi Only!) @@ -34,14 +42,119 @@ In some cases, you want to start the application without an actual app window. I 1. Duplicate `config/config.js.sample` to `config/config.js`. 2. Modify your required settings. -## Todo List +The following properties can be configured: -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. -- [ ] Rewrite the [alert](modules/default/alert) module in vanilla JavaScript. -- [ ] Write all the documentation. +
Option | +Description | +
---|---|
port |
+ HThe port on which the MagicMirror² server will run.
+ Default value: 8080
+ |
+
language |
+ The language of the interface. (Note: Not all elements will be translated.)
+ Possible values: en , nl , ru , fr , etc ...
+ Default value: en
+ |
+
timeFormat |
+ The time notation.
+ Possible values: 24 or 12
+ Default value: 24
+ |
+
modules |
+ An array of of the active modules. The array should contain objects. See module configuration below for more information. + |
+
Option | +Description | +
---|---|
module |
+ The name of the module. This can also contain the subfolder:
+ Example: clock
+ Example: default/calendar
+ Example: custommodules/mymodule
+ |
+
position |
+ The location of the module in which the module will be loaded.
+ Possible values: top_bar , top_left , top_center , top_right , upper_third , middle_center , lower_third , bottom_left , bottom_center , bottom_right , bottom_bar , fullscreen_above , fullscreen_below + Note: This field is optional, but most modules require this field to be set. Check the documentation of the module for more info. + |
+
classes |
+ Additional classed which are added to the module.
+ Note: This field is optional. + |
+
config |
+ An object with the module configuration properties. Check the documentation of the module for more info. + Note: This field is optional + |
+