Skip to content

Commit

Permalink
docs: update preview (#37)
Browse files Browse the repository at this point in the history
* update preview

* fix geo call

* update preview

* Update README.md
  • Loading branch information
CFenner authored Jan 4, 2024
1 parent f299793 commit 5740787
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 3 deletions.
Binary file added .github/preview-good.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/preview-unhealthy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/preview-very-unhealthy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .github/preview1.png
Binary file not shown.
Binary file removed .github/preview2.png
Binary file not shown.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,15 @@ A module for the [MagicMirror](https://github.com/MichMich/MagicMirror) to displ

## Preview

![preview](.github/preview1.png)
![preview](.github/preview-unhealthy.png)

![preview](.github/preview2.png)
with header and location

![preview](.github/preview-good.png)

without any header

![preview](.github/preview-very-unhealthy.png)

## Usage

Expand Down Expand Up @@ -50,7 +56,7 @@ To use the WAQI API you need to [request a token](https://aqicn.org/data-platfor

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/`.

You may also get the data for specific longitude and latitude. Set the `location` to `geo:<lat>;<long>/` and replace `<lat>` and `<long>` with your values.
You may also get the data for specific longitude and latitude. Set the `location` to `geo::lat;:lng/` and replace `lat` and `lng` with your values.

You may want to set the following options in the config section as well:

Expand Down

0 comments on commit 5740787

Please sign in to comment.