kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-08-21 12:55:22 +00:00
Code Issues Projects Releases Wiki Activity

Remove docs and link to docs.magicmirror.builders.

Browse Source
This commit is contained in:
Michael Teeuw
2020-01-12 13:01:56 +01:00
parent d2afdc82f1
commit 1152689f34
19 changed files with 11 additions and 1514 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
modules/default/helloworld/README.md
View File

@@ -1,25 +1,4 @@
# Module: Hello World
The `helloworld` module is one of the default modules of the MagicMirror. It is a simple way to display a static text on the mirror.
## Using the module
To use this module, add it to the modules array in the `config/config.js` file:
````javascript
modules: [
{
module: "helloworld",
position: "bottom_bar", // This can be any of the regions.
config: {
// See 'Configuration options' for more information.
text: "Hello world!"
}
}
]
````
## Configuration options
The following properties can be configured:
| Option | Description
| ------ | -----------
| `text` | The text to display. <br><br> **Example:** `'Hello world!'` <br> **Default value:** `'Hello world!'`
For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/helloworld.html).