diff --git a/README.md b/README.md index d177d02..41b99b2 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ The following properties can be configured: |Option|Description| |---|---| -|`alwaysDisplay`|Set this to always display the specified default effect, regardless of weather. Does not work for custom effects; to always display custom effects leave out weatherCode, month, day and year.

**Options:** `snow`, `rain`, `cloudy`,`fog`
**Type:** `string`
**Default value:** `null`| +|`alwaysDisplay`|Set this to always display the specified default effect, regardless of weather. Does not work for custom effects; to always display custom effects leave out weatherCode, month, day and year.

**Options:** `snow`, `rain`, `cloudy`,`fog`, `lightning`, `rain-lightning`
**Type:** `string`
**Default value:** `null`| |`api_key`|**Required** This is the API key you need to use to request weather data from the OpenWeatherMap site. Details on how to request an API key can be found [here](https://home.openweathermap.org/users/sign_up)

**Type:** `string`
**Default value:** `null`| |`effectDuration`|The length, in milliseconds, to display the effect.

**Type:** `number`
**Default value:** `120000`| |`effectDelay`|The length, in milliseconds, to wait to restart the effect.

**Type:** `number`
**Default value:** `60000`| @@ -78,6 +78,9 @@ The following properties can be configured: |`hideRain`|If true, will never display the "rain" effect.

**Type:** `boolean`
**Default value:** `false`| |`hideClouds`|If true, will never display the "cloudy" effect.

**Type:** `boolean`
**Default value:** `false`| |`hideFog`|If true, will never display the "fog" effect.

**Type:** `boolean`
**Default value:** `false`| +|`hideLightning`|If true, will never display the "lightning" effect.

**Type:** `boolean`
**Default value:** `false`| +|`lightning1Count`|Sets how many times the lightning1.png image will be displayed during the effect duration if current weather is thunderstorm.

**Type:** `number`
**Default value:** `2`| +|`lightning2Count`|Sets how many times the lightning2.png image will be displayed during the effect duration if current weather is thunderstorm.

**Type:** `number`
**Default value:** `3`| |`locationID`|**Required (or use lat/lon)** The locationID from OpenWeatherMap for your city to get current weather. [Follow steps here to find city ID](https://www.dmopress.com/openweathermap-howto/)

**Type:** `integer`
**Default value:** `0`| |`lat`|**Required with lon (or use locationID)** This is the latitude of the location you want to get the weather for.

**Type:** `number`
**Default value:** `0.0`| |`lon`|**Required with lat (or use locationID)** This is the longitude of the location you want to get the weather for.

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