Merge remote-tracking branch 'upstream/master'

Author: briodan

development/core-module-file.md

@@ -332,6 +332,12 @@ Whenever your module need to be updated, call the `updateDom(speed)` method. It
 requests the MagicMirror core to update its dom object. If you define the speed,
 the content update will be animated, but only if the content will really change.
 
+Note that the rendering of the updated dom on the screen will happen
+asynchronously. You can listen for the
+[`DOM_OBJECTS_UPDATED` notification](/development/notifications.html) to know
+when the rendering is complete and the new dom is safe to interact with. This
+notification only fires if the content will really change.
+
 As an example: the clock modules calls this method every second:
 
 ```javascript

development/notifications.md

@@ -17,15 +17,16 @@ Additional technical information on the notifications can be found in the
 
 The system sends three notifications when starting up:
 
-| Notification          | Payload | Description                                                                            |
-| --------------------- | ------- | -------------------------------------------------------------------------------------- |
-| `ALL_MODULES_STARTED` | _none_  | All modules are started. You can now send notifications to other modules.              |
-| `DOM_OBJECTS_CREATED` | _none_  | All dom objects are created. The system is now ready to perform visual changes.        |
-| `MODULE_DOM_CREATED`  | _none_  | This module's dom has been fully loaded. You can now access your module's dom objects. |
+| Notification          | Payload | Description                                                                                                                                                                                                                                                                |
+| --------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ALL_MODULES_STARTED` | _none_  | All modules are started. You can now send notifications to other modules.                                                                                                                                                                                                  |
+| `DOM_OBJECTS_CREATED` | _none_  | All dom objects are created. The system is now ready to perform visual changes.                                                                                                                                                                                            |
+| `MODULE_DOM_CREATED`  | _none_  | This module's dom has been fully loaded. You can now access your module's dom objects.                                                                                                                                                                                     |
+| `MODULE_DOM_UPDATED`  | _none_  | This module's dom has been updated and re-rendered. You can now access your module's (updated) dom objects. This notification is sent in response to a call to [`updateDom`](https://docs.magicmirror.builders/development/core-module-file.html#module-instance-methods). |
 
 # Default module notifications
 
-These notifications are send by the default modules:
+These notifications are sent by the default modules:
 
 | Notification           | Payload                                                                                                                | Description                                                                                                                                                                                                         |
 | ---------------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

getting-started/installation.md

@@ -21,8 +21,8 @@ These instructions deploy a standalone version of MagicMirror², for [Server Onl
 - [Linux based distributions](https://github.com/nodesource/distributions)
 - [Others](https://nodejs.org/en/download)
 
-2. check if `git` is installed on your machine by executing `git`
-   (should show usage), otherwise install it
+2. check if `git` is installed on your machine by executing `git` (should show
+   usage), otherwise install it
 3. Clone the repository:
    `git clone https://github.com/MagicMirrorOrg/MagicMirror`
 4. Enter the repository: `cd MagicMirror/`
@@ -72,6 +72,11 @@ team. Use these scripts and methods at your own risk.
   of the box with a default setup of MagicMirror, under the hood it uses the
   [docker setup](https://gitlab.com/khassel/magicmirror).
 
+### NPM
+
+- We also publish the latest version of MagicMirror to the
+  [npm-registry](https://www.npmjs.com/package/magicmirror).
+
 ## Other Operating Systems
 
 ### Windows:

modules/compliments.md

@@ -58,6 +58,16 @@ compliments.
 Compliments can be set for a specific day in the format `YYYY-MM-DD`. `.` can be
 used as a wildcard.
 
+starting in Version 2.29, the compliments configuration can use a cron type
+specification, which provides more options. In addition to date, one can use
+hours, minutes and day of week for additional control the cron format string is
+5 groups of space separated values<br><br> **minute hour day month
+day_of_week**<br><br> each can be a range, and use numbers or names see
+https://crontab-generator.org for a visual cron syntax creator.. this tool asks
+for the command to be executed (cron is usually used to execute commands on a
+schedule), just use anything, and take the first 5 space separated tokens of the
+result.
+
 If set, the weather can be used for compliments. The available properties are:
 
 - `day_sunny`
@@ -92,6 +102,36 @@ config: {
 }
 ```
 
+#### Example use with a cron entry
+
+```javascript
+config: {
+	compliments: {
+		"48-50 16-18 * * 5,6": [
+			"Happy Hour!", "Its a Party"
+		]
+	}
+}
+```
+
+this means, on Friday or Saturday, every week (\* (every) month/day) between
+16:48-16:50, 17:48-17:50, and 18:48-18:50, the assigned messages will be used.
+note: like with the date only setting, if these are the only possible messages
+you want displayed, you need to set **specialDayUnique:true**
+
+As another example you could use this for scary messages ONLY between 8 and
+9pm on Halloween evening:
+
+```javascript
+config: {
+    compliments: {
+        "* 20-21 31 10 *": [
+            "Boo!!"
+        ]
+    }
+}
+```
+
 #### Example use with weather module
 
 ```javascript