From a2892ad097d2928b8d74ab5dc7e9ff1d511afce8 Mon Sep 17 00:00:00 2001 From: Kyle Carson Date: Sun, 5 Feb 2017 19:29:35 -0600 Subject: [PATCH] Update Readme and changelog --- CHANGELOG.md | 1 + modules/default/compliments/README.md | 12 +++++++++--- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6c6e31e3..b2efe4eb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install` ### Changed +- Add `anytime` group for Compliments module. - Installer: Use init config.js from config.js.sample. - Switched out `rrule` package for `rrule-alt` and fixes in `ical.js` in order to fix calendar issues. ([#565](https://github.com/MichMich/MagicMirror/issues/565)) - Make mouse events pass through the region fullscreen_above to modules below. diff --git a/modules/default/compliments/README.md b/modules/default/compliments/README.md index 8ef9e2fb..171c86c0 100644 --- a/modules/default/compliments/README.md +++ b/modules/default/compliments/README.md @@ -29,12 +29,12 @@ The following properties can be configured: | ---------------- | ----------- | `updateInterval` | How often does the compliment have to change? (Milliseconds)

**Possible values:** `1000` - `86400000`
**Default value:** `30000` (30 seconds) | `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 three arrays: `morning`, `afternoon` and`evening`. 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 three arrays: `morning`, `afternoon` and `evening`. - `compliments.json`
**Default value:** `null` (Do not load from file) +| `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) ### Compliment configuration -The `compliments` property contains an object with three arrays: morning, afternoon andevening. Based on the time of the day, the compliments will be picked out of one of these arrays. The arrays contain one or multiple compliments. +The `compliments` property contains an object with four arrays: morning, afternoon, evening and anytime. Based on the time of the day, the compliments will be picked out of one of these arrays. The arrays contain one or multiple compliments. If use the currentweather is possible use a actual weather for set compliments. The availables properties are: @@ -78,6 +78,9 @@ config: { ````javascript config: { compliments: { + anytime: [ + "Hey there sexy!" + ], morning: [ "Good morning, handsome!", "Enjoy your day!", @@ -107,6 +110,9 @@ around them ("morning", "afternoon", "evening", "snow", "rain", etc.). #### Example compliments.json file: ````json { + "anytime" : [ + "Hey there sexy!" + ], "morning" : [ "Good morning, sunshine!", "Who needs coffee when you have your smile?",