From 360e1e327e2d6a885b971ad6b9ce15e9d6a75ca3 Mon Sep 17 00:00:00 2001 From: Nicholas Hubbard Date: Sun, 10 Apr 2016 17:14:19 -0400 Subject: [PATCH] Markdown Refresh: Part II --- README.md | 113 ++++++++++++++---------------------------------------- 1 file changed, 29 insertions(+), 84 deletions(-) diff --git a/README.md b/README.md index 4bca6f89..d981782f 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@

-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. +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. **WARNING!** This version is in a *very* early stage. It is **not** completed yet. **Please** use the master branch. @@ -56,92 +56,37 @@ The following wiki links are helpful in the cofiguration of your MagicMirror² o The following properties can be configured: - - - - - - - - - - - - - - - - - - - - - - - - - - - -
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. -
+| 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. | 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.
- Note: Multiple modules with the same position will be ordered based on the order in the config file. -
classesAdditional classed which are added to the module. -
Note: This field is optional. -
headerTo display a header text above the module, add the header property. -
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 -
+| 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. +**Note:** Multiple modules with the same position will be ordered based on the order in the config file. | +| `classes` | Additional classed which are added to the module. +**Note:** This field is optional. | +| `header` | To display a header text above the module, add the header property. +**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 | Configuration example: