Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sytone authored Jul 13, 2018
1 parent de88ef1 commit eff2ce1
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions magic_mirror/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,13 @@ Example add-on configuration:

```json
{
"gitupdate": true,
"npmupdate": false
"gitupdate": true,
"npmupdate": false,
"npminstall": false,
"modules": [
{ "name": "MMM-OnScreenMenu", "git": "https://github.com/shbatm/MMM-OnScreenMenu" },
{ "name": "DailyXKCD", "git": "https://github.com/Blastitt/DailyXKCD.git" }
]
}
```

Expand All @@ -48,6 +53,15 @@ when the addon starts up.
This option will call a npm update to ensure it is latest, this may be needed
if you are using your own modules or have a security issue.

### Option: `npminstall`

If enabled npm install will be run after the git update. Off by default.

### Option: `modules`

This is a collections of modules you want to have installed for your system. It
will pull them down and run a `npm install` on them for you.

## MagicMirror² configuration and user manuals

The add-on does not configure MagicMirror² for you. When it starts it will create
Expand All @@ -64,6 +78,9 @@ When the addon starts it will copy these settings into the container and start t
MagicMirror² process. If you edit or update these you will need to restart the
MagicMirror² addon in the HASS.IO interface.

If you use the modules folder in the Home Assistant configuration make sure you
have done a `npm install` as it is just copied across.

For more information about configuring MagicMirror², please go to
[https://magicmirror.builders/](https://magicmirror.builders/)

Expand Down

0 comments on commit eff2ce1

Please sign in to comment.