From 14d4913a87c8405edfd3fcaf7578444a7dba22db Mon Sep 17 00:00:00 2001 From: Edward Shen <6173958+edward-shen@users.noreply.github.com> Date: Mon, 7 May 2018 13:10:42 -0400 Subject: [PATCH] compacted config type --- readme.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/readme.md b/readme.md index cbc11c8..ec7e718 100644 --- a/readme.md +++ b/readme.md @@ -50,13 +50,13 @@ modules: [ ## Configuration options -Option |Type |Default Value |Description ----------------|-----------------------------------------------------------|------------------------|--------- -`modules` |`[ [String, String, ...],`
`[String, String, ...], ...]`|`[]` |A 2D String array of what each module should be on which page. Notethat all entries must take their class name (e.g. this module's class name is `MMM-pages`, while the default modules may just have `newsfeed`, without the `MMM-` prefix. -`excludes` |`[ String, String, ... ]` |`["MMM-page-indicator"]`|Which modules should show up all the time. -`animationTime`|`int` |`1000` |Fading animation time. Set to `0` for instant change. Value is in milliseconds (1 second = 1000 milliseconds). -`rotationTime` |`int` |`0` |Time, in milliseconds, between automatic page changes. -`delayTime` |`int` |`0` |Time, in milliseconds, of how long should a manual page change linger before returning to automatic page changing. In other words, how long should the timer wait for after you manually change a page. This does include the animation time, so you may wish to increase it by a few seconds or so to account for the animation time. +Option |Type |Default Value |Description +---------------|------------------|------------------------|----------- +`modules` |`[[String...]...]`|`[]` |A 2D String array of what each module should be on which page. Notethat all entries must take their class name (e.g. this module's class name is `MMM-pages`, while the default modules may just have `newsfeed`, without the `MMM-` prefix. +`excludes` |`[String...]` |`["MMM-page-indicator"]`|Which modules should show up all the time. +`animationTime`|`int` |`1000` |Fading animation time. Set to `0` for instant change. Value is in milliseconds (1 second = 1000 milliseconds). +`rotationTime` |`int` |`0` |Time, in milliseconds, between automatic page changes. +`delayTime` |`int` |`0` |Time, in milliseconds, of how long should a manual page change linger before returning to automatic page changing. In other words, how long should the timer wait for after you manually change a page. This does include the animation time, so you may wish to increase it by a few seconds or so to account for the animation time. For the `module` configuration option, the first element of the outer array should consist of elements that should be on the first page. The second element