diff --git a/modules/default/compliments/README.md b/modules/default/compliments/README.md index ca75b475..10a45b8f 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

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