Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add token part to readme #26

Merged
merged 1 commit into from
Jan 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,15 @@ Add the module configuration to your `config.js` file.
header: 'AQI', //choose a header if you like
config: {
location: 'beijing' // the location to check the index for
token: '' // add your token here
}
},
```

### Token

To use the WAQI API you need to [request a token](https://aqicn.org/data-platform/token/).

### Location

Determine the station you want to display. Select a station on the [map](https://aqicn.org/here/) and copy the location part from the URL. For example http://aqicn.org/city/netherland/utrecht/griftpark/ would be `netherland/utrecht/griftpark/`.
Expand Down
1 change: 0 additions & 1 deletion helper.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ module.exports = {
},
start: function () {
console.log('AirQuality helper started ...')
this.token = null
},
loadData: async function (config) {
const self = this
Expand Down