Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ryck committed Feb 8, 2018
1 parent 6f46836 commit 94a449f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ The entry in `config.js` can include the following options:

|Option|Description|
|---|---|
|`token`|**Required** Your private API token ([see aqicn.org/data-platform/token/](http://aqicn.org/data-platform/token/))<br>**Type:** `integer`<br>|
|`token`|**Required** Your private API token ([see aqicn.org/data-platform/token/](http://aqicn.org/data-platform/token/))<br>**Type:** `string`|
|`city`|**Required** Name of the city (eg beijing), or id (eg @7397). You can also use the keyword `here` to use geolocation to get your city<br>**Type:** `string`<br>**Possible values:** `here` for geolocation, `nameOfCity` or `@id`<br> **Default value:** `here`|
| `iaqi`|Display individual AQI for all pollutants (PM2.5, PM10, NO2, CO, SO2, Ozone)<br>**Type:** `boolean`<br>**Possible values:** `true` or `false`<br> **Default value:** `true`|
|`updateInterval `|How often the data is updated. (Milliseconds)<br>**Type:** `integer`<br>**Default value:** `30 * 60 * 1000` (Half hour)|
| `initialLoadDelay`|The initial delay before loading. If you have multiple modules that use the same API key, you might want to delay one of the requests. (Milliseconds)<br>**Type:** `integer`<br>**Possible values:** `1000` - `5000` <br> **Default value:** `0`|
| `animationSpeed`|Speed of the update animation. (Milliseconds)<br>**Type:** `integer`<br>**Possible values:**`0` - `5000` <br> **Default value:** `1000` (1 second)|
| `debug`| Show debug information. <br>**Possible values:** `true` or `false` <br> **Default value:** `false`|
| `debug`| Show debug information.<br>**Type:** `boolean`<br>**Possible values:** `true` or `false` <br> **Default value:** `false`|


Here is an example of an entry in `config.js`
Expand Down

0 comments on commit 94a449f

Please sign in to comment.