From 34361ccd1c16bea5d85869eb25e0694aad0d2de3 Mon Sep 17 00:00:00 2001 From: xuanyou Date: Thu, 18 May 2017 18:14:43 +0800 Subject: [PATCH 1/2] Update documentation for compliments module Added documentation for the config variable "classes" that allows the user to override the css classes of the compliments module display. Fixed the erroneous "a default calendar is shown" to "default compliments". --- modules/default/compliments/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/default/compliments/README.md b/modules/default/compliments/README.md index 171c86c0..835fbe1e 100644 --- a/modules/default/compliments/README.md +++ b/modules/default/compliments/README.md @@ -13,7 +13,7 @@ modules: [ // Best results in one of the middle regions like: lower_third config: { // The config property is optional. - // If no config is set, an example calendar is shown. + // If no config is set, the default compliments are shown. // See 'Configuration options' for more information. } } @@ -31,6 +31,7 @@ The following properties can be configured: | `fadeSpeed` | Speed of the update animation. (Milliseconds)

**Possible values:**`0` - `5000`
**Default value:** `4000` (4 seconds) | `compliments` | The list of compliments.

**Possible values:** An object with four arrays: `morning`, `afternoon`, `evening` and `anytime`. See _compliment configuration_ below.
**Default value:** See _compliment configuration_ below. | `remoteFile` | External file from which to load the compliments

**Possible values:** Path to a JSON file containing compliments, configured as per the value of the _compliments configuration_ (see below). An object with four arrays: `morning`, `afternoon`, `evening` and `anytime`. - `compliments.json`
**Default value:** `null` (Do not load from file) +| `classes` | Override the CSS classes of the div showing the compliments ### Compliment configuration From cbb6e4d6f3fe5e722f8385279294ae498634c82a Mon Sep 17 00:00:00 2001 From: xuanyou Date: Thu, 18 May 2017 18:25:17 +0800 Subject: [PATCH 2/2] Update docs: classes config variable default value --- modules/default/compliments/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/default/compliments/README.md b/modules/default/compliments/README.md index 835fbe1e..13063a3b 100644 --- a/modules/default/compliments/README.md +++ b/modules/default/compliments/README.md @@ -31,7 +31,7 @@ The following properties can be configured: | `fadeSpeed` | Speed of the update animation. (Milliseconds)

**Possible values:**`0` - `5000`
**Default value:** `4000` (4 seconds) | `compliments` | The list of compliments.

**Possible values:** An object with four arrays: `morning`, `afternoon`, `evening` and `anytime`. See _compliment configuration_ below.
**Default value:** See _compliment configuration_ below. | `remoteFile` | External file from which to load the compliments

**Possible values:** Path to a JSON file containing compliments, configured as per the value of the _compliments configuration_ (see below). An object with four arrays: `morning`, `afternoon`, `evening` and `anytime`. - `compliments.json`
**Default value:** `null` (Do not load from file) -| `classes` | Override the CSS classes of the div showing the compliments +| `classes` | Override the CSS classes of the div showing the compliments

**Default value:** `thin xlarge bright` ### Compliment configuration