From 7457432c2a6c1533e679ccf781a6d7ebd33cb657 Mon Sep 17 00:00:00 2001 From: Nicholas Hubbard Date: Sun, 10 Apr 2016 17:05:54 -0400 Subject: [PATCH 1/7] Finally... centered badges! --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 54ed2d57..06392c65 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ ![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) -[![License](https://img.shields.io/badge/license-MIT-blue.svg)](http://choosealicense.com/licenses/mit) + Dependency Status + devDependency Status + Node Version + License From 1b9d91936be29cba2cf9215066ab5fb708011449 Mon Sep 17 00:00:00 2001 From: Nicholas Hubbard Date: Sun, 10 Apr 2016 17:06:21 -0400 Subject: [PATCH 2/7] Centered badges... now? --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 06392c65..8e1452f7 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ ![MagicMirror²: The open source modular Smart Mirror platform. ](.github/header.png) - +

Dependency Status devDependency Status Node Version License - +

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. From 4b8bc65fb733e8a0d5281a4aa536f228ab3da62d Mon Sep 17 00:00:00 2001 From: Nicholas Hubbard Date: Sun, 10 Apr 2016 17:11:31 -0400 Subject: [PATCH 3/7] Markdown Refresh: Part I --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8e1452f7..4bca6f89 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -![MagicMirror²: The open source modular Smart Mirror platform. ](.github/header.png) +![MagicMirror²: The open source modular smart mirror platform. ](.github/header.png)

- Dependency Status - devDependency Status - Node Version - License + Dependency Status + devDependency Status + Node Version + License

@@ -12,7 +12,7 @@ This version of the Magic Mirror software focusses on a modular plugin system. B **WARNING!** This version is in a *very* early stage. It is **not** completed yet. **Please** use the master branch. -## Table of contents +## Table Of Contents - [Usage](#usage) - [Configuration](#configuration) From 360e1e327e2d6a885b971ad6b9ce15e9d6a75ca3 Mon Sep 17 00:00:00 2001 From: Nicholas Hubbard Date: Sun, 10 Apr 2016 17:14:19 -0400 Subject: [PATCH 4/7] 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: From 09f0b251abf3a3ba74a8237e6ffe870196f5b5f5 Mon Sep 17 00:00:00 2001 From: Nicholas Hubbard Date: Sun, 10 Apr 2016 17:49:50 -0400 Subject: [PATCH 5/7] Markdown Refresh: Part III --- README.md | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index d981782f..2b4677e9 100644 --- a/README.md +++ b/README.md @@ -58,17 +58,10 @@ The following properties can be configured: | 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. | - +| port | The port on which the MagicMirror² server will run on. The default value is `8080`. | +| language | The language of the interface. (Note: Not all elements will be localized.) Possible values are `en`, `nl`, `ru`, `fr`, etc., but the default value is `en`. | +| timeFormat | The form of time notation that will be used. Possible values are `12` or `24`. The default is `24`. | +| module | An array of active modules. **The array must contain objects. See the next table below for more information.** | Module configuration: | Option | Description | From 64091b54631f9cb20d6ca89123b8e108e5a2c506 Mon Sep 17 00:00:00 2001 From: Nicholas Hubbard Date: Sun, 10 Apr 2016 17:59:31 -0400 Subject: [PATCH 6/7] Markdown Refresh: Part IV --- README.md | 63 +++++++++++-------------------------------------------- 1 file changed, 12 insertions(+), 51 deletions(-) diff --git a/README.md b/README.md index 2b4677e9..e2e5bb53 100644 --- a/README.md +++ b/README.md @@ -56,61 +56,22 @@ The following wiki links are helpful in the cofiguration of your MagicMirror² o The following properties can be configured: -| Option | Description | +| **Option** | **Description** | | --- | --- | -| port | The port on which the MagicMirror² server will run on. The default value is `8080`. | -| language | The language of the interface. (Note: Not all elements will be localized.) Possible values are `en`, `nl`, `ru`, `fr`, etc., but the default value is `en`. | -| timeFormat | The form of time notation that will be used. Possible values are `12` or `24`. The default is `24`. | -| module | An array of active modules. **The array must contain objects. See the next table below for more information.** | +| `port` | The port on which the MagicMirror² server will run on. The default value is `8080`. | +| `language` | The language of the interface. (Note: Not all elements will be localized.) Possible values are `en`, `nl`, `ru`, `fr`, etc., but the default value is `en`. | +| `timeFormat` | The form of time notation that will be used. Possible values are `12` or `24`. The default is `24`. | +| `modules` | An array of active modules. **The array must contain objects. See the next table below for more information.** | + Module configuration: -| Option | Description | +| **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: - -````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: "lower_third", - classes: "small" - config: { - text: "Hello world!" - } - } - ] -}; - -// See the config.js.sample for additional required code. -```` +| `module` | The name of the module. This can also contain the subfolder. Valid examples include `clock`, `default/calendar` and `custommodules/mymodule`. | +| `position` | The location of the module in which the module will be loaded. Possible values are `top_ bar`, `top_left`, `top_center`, `top_right`, `upper_third`, `middle_center`, `lower_third`, `bottom_left`, `bottom_center`, `bottom_right`, `bottom_bar`, `fullscreen_above`, and `fullscreen_below`. This field is optional but most modules require this field to set. Check the documentation of the module for more information. Multiple modules with the same position will be ordered based on the order in the configuration file. | +| `classes` | Additional classes which are passed to the module. The field is optional. | +| `header` | To display a header text above the module, add the header property. This field is optional. | +| `config` | An object with the module configuration properties. Check the documentation of the module for more information. This field is optional, unless the module requires extra configuration. | ## Modules From c22ce3b9a282131be4370d8f8ba15f68b01c2f75 Mon Sep 17 00:00:00 2001 From: Nicholas Hubbard Date: Sun, 10 Apr 2016 18:02:03 -0400 Subject: [PATCH 7/7] Markdown Refresh: Part V --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e2e5bb53..cb8047dd 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ The following properties can be configured: Module configuration: -| **Option | Description** | +| **Option** | **Description** | | --- | --- | | `module` | The name of the module. This can also contain the subfolder. Valid examples include `clock`, `default/calendar` and `custommodules/mymodule`. | | `position` | The location of the module in which the module will be loaded. Possible values are `top_ bar`, `top_left`, `top_center`, `top_right`, `upper_third`, `middle_center`, `lower_third`, `bottom_left`, `bottom_center`, `bottom_right`, `bottom_bar`, `fullscreen_above`, and `fullscreen_below`. This field is optional but most modules require this field to set. Check the documentation of the module for more information. Multiple modules with the same position will be ordered based on the order in the configuration file. |