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.

Sign up for GitHub

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: update preview #37

Merged
merged 5 commits into from
Jan 4, 2024
Merged

docs: update preview #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
75acb9f
update preview
CFenner Jan 4, 2024
4264b1f
fix geo call
CFenner Jan 4, 2024
bb7673b
update preview
CFenner Jan 4, 2024
da24e75
Merge branch 'main' into preview
CFenner Jan 4, 2024
9b24d0d
Update README.md
CFenner Jan 4, 2024
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
Binary file added .github/preview-good.png
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
Binary file not shown.
Binary file removed .github/preview2.png
View file
Open in desktop
Binary file not shown.
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
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