diff --git a/README.md b/README.md index 3d6e578..d177d02 100644 --- a/README.md +++ b/README.md @@ -96,6 +96,8 @@ The following properties can be configured: |`holiday`|Will display the effect on the holiday found at [https://www.timeanddate.com/holidays/us/?hol=43122559](https://www.timeanddate.com/holidays/us/?hol=43122559). Simply copy the "Name" value from that table.

**Type:** `string`
**Default value:** `null`| |`images`|An array of image files to display at random for this effect. All files need to be in the "images" folder of the MMM-DynamicWeather module folder.

**Type:** `string[]`
**Default value:** `null`| |`recurrence`|Display the effect repeatedly.
Yearly - Not a recurrence option, just leave year unset or zero.

**Options:**`monthly`,`weekly`,`weekdays`,`weekends`
**Type:** `string`
**Default value:** `null`| +|`maxSpeed`|The max speed factor. Closer to zero is faster.

**Type:** `number`
**Default value:** `100`| +|`minSpeed`|The min speed factor. Closer to zero is faster.

**Type:** `number`
**Default value:** `50`| |`size`|The size factor to display the image; larger the number the larger the picture.

**Type:** `number`
**Default value:** `1`| |`weatherCode`|The effect will be displayed whenever the current weather matches this code. You can find all valid codes [here](https://openweathermap.org/weather-conditions)
This does not change the default weather effects, those will still be shown unless `hideSnow`, `hideRain` or `hideClouds` is turned on.

**Type:** `number`
**Default value:** `0`| |`weatherCodeMin`|Similar to `weatherCode` but will show the effect if the current weather code is greater or equal to this value.

**Type:** `number`
**Default value:** `0`|