diff --git a/CHANGELOG.md b/CHANGELOG.md index bf3c9d83..8f4b522b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,9 +10,16 @@ This project adheres to [Semantic Versioning](http://semver.org/). *This release is scheduled to be released on 2018-10-01.* ### Added -- Added font-awesome 5, still has 4 for backwards compatibility. +- Font-awesome 5, still has 4 for backwards compatibility. +- Missing `showEnd` in calendar documentation +- Screenshot for the new feed module +- Screenshot for the compliments module +- Screenshot for the clock module +- Screenshot for the current weather +- Screenshot for the weather forecast module ### Fixed +- Fixed Polish translation for Single Update Info ### Updated diff --git a/config/config.js.sample b/config/config.js.sample index 91aa05c9..6e419e59 100644 --- a/config/config.js.sample +++ b/config/config.js.sample @@ -69,7 +69,7 @@ var config = { header: "Weather Forecast", config: { location: "New York", - locationID: "5128581", //ID from http://www.openweathermap.org/help/city_list.txt + locationID: "5128581", //ID from https://openweathermap.org/city appid: "YOUR_OPENWEATHER_API_KEY" } }, diff --git a/modules/default/calendar/README.md b/modules/default/calendar/README.md index ae516a63..d49faf62 100755 --- a/modules/default/calendar/README.md +++ b/modules/default/calendar/README.md @@ -44,6 +44,7 @@ The following properties can be configured: | `dateFormat` | Format to use for the date of events (when using absolute dates)

**Possible values:** See [Moment.js formats](http://momentjs.com/docs/#/parsing/string-format/)
**Default value:** `MMM Do` (e.g. Jan 18th) | `fullDayEventDateFormat` | Format to use for the date of full day events (when using absolute dates)

**Possible values:** See [Moment.js formats](http://momentjs.com/docs/#/parsing/string-format/)
**Default value:** `MMM Do` (e.g. Jan 18th) | `timeFormat` | Display event times as absolute dates, or relative time, or using absolute date headers with times for each event next to it

**Possible values:** `absolute` or `relative` or `dateheaders`
**Default value:** `relative` +| `showEnd` | Display the end of a date as well

**Possible values:** `true` or `false`
**Default value:** `true` | `getRelative` | How much time (in hours) should be left until calendar events start getting relative?

**Possible values:** `0` (events stay absolute) - `48` (48 hours before the event starts)
**Default value:** `6` | `urgency` | When using a timeFormat of `absolute`, the `urgency` setting allows you to display events within a specific time frame as `relative`. This allows events within a certain time frame to be displayed as relative (in xx days) while others are displayed as absolute dates

**Possible values:** a positive integer representing the number of days for which you want a relative date, for example `7` (for 7 days)

**Default value:** `7` | `broadcastEvents` | If this property is set to true, the calendar will broadcast all the events to all other modules with the notification message: `CALENDAR_EVENTS`. The event objects are stored in an array and contain the following fields: `title`, `startDate`, `endDate`, `fullDayEvent`, `location` and `geo`.

**Possible values:** `true`, `false`

**Default value:** `true` diff --git a/modules/default/clock/README.md b/modules/default/clock/README.md index a231d73c..27e2ca5d 100644 --- a/modules/default/clock/README.md +++ b/modules/default/clock/README.md @@ -2,6 +2,11 @@ The `clock` module is one of the default modules of the MagicMirror. This module displays the current date and time. The information will be updated realtime. +## Screenshot + +- Current time +![Current time](clock_screenshot.png) + ## Using the module To use this module, add it to the modules array in the `config/config.js` file: diff --git a/modules/default/clock/clock_screenshot.png b/modules/default/clock/clock_screenshot.png new file mode 100644 index 00000000..a1f30f57 Binary files /dev/null and b/modules/default/clock/clock_screenshot.png differ diff --git a/modules/default/compliments/README.md b/modules/default/compliments/README.md index 7220cd29..c89a3707 100644 --- a/modules/default/compliments/README.md +++ b/modules/default/compliments/README.md @@ -2,6 +2,10 @@ The `compliments` module is one of the default modules of the MagicMirror. This module displays a random compliment. +## Screenshots +- Compliments Screenshot +![Compliments Screenshot](compliments_screenshot.png) + ## Using the module To use this module, add it to the modules array in the `config/config.js` file: @@ -45,22 +49,22 @@ The `compliments` property contains an object with four arrays: morning