diff --git a/README.md b/README.md index c01cb2aa..2a2c898b 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,18 @@ [![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) -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. + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription
portHThe port on which the MagicMirror² server will run. +
Default value: 8080 +
languageThe language of the interface. (Note: Not all elements will be translated.) +
Possible values:en, nl, ru, fr, etc ... +
Default value: en +
timeFormatThe time notation. +
Possible values: 24 or 12 +
Default value: 24 +
modulesAn array of of the active modules.
The array should contain objects. See module configuration below for more information. +
+ +Module configuration: + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription
moduleThe name of the module. This can also contain the subfolder: +
Example: clock +
Example: default/calendar +
Example: custommodules/mymodule +
positionThe 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. +
classesAdditional classed which are added to the module. +
Note: This field is optional. +
configAn object with the module configuration properties. Check the documentation of the module for more info.
+ Note: This field is optional +
+ +Configuration example: + +````javascript +var config = { + port: 8080, + language: 'en', + timeFormat: 24, + + modules: [ + { + module: "helloworld", + position: "middle_center", + classes: "large thin bright" + config: { + text: "MagicMirror²" + } + }, + { + module: "helloworld", + position: "middle_center", + classes: "small" + config: { + text: "Hello world!" + } + } + ] +}; + +// See the config.js.sample for additional required code. +```` ## Modules @@ -66,7 +179,15 @@ The following modules are created by their respective authors. - **[MMM-wordnik by Vendittelli](https://github.com/SVendittelli/MMM-wordnik)**
Get the word of the day, its definition, and origin ... -## Contributing +## 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. @@ -77,4 +198,4 @@ Please keep the following in mind: - **Major Bug Fixes**: please discuss your approach in an GitHub issue before you start to alter a big part of the code. - **New Features**: please please discuss in a GitHub issue before you start to alter a big part of the code. Without discussion upfront, the pull request will not be accepted / merged. -Thanks for your help in making Magic Mirror better! +Thanks for your help in making MagicMirror² better!