Skip to content

Commit 8be51f9

Browse files
committed
Update README.md
1 parent de95613 commit 8be51f9

File tree

1 file changed

+11
-28
lines changed

1 file changed

+11
-28
lines changed

README.md

Lines changed: 11 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
# <img src="https://user-images.githubusercontent.com/1029142/32918679-7336704a-cb23-11e7-92b2-d8a7f2588055.png" width="38px" alt="Airqmon icon" align="top" /> Airqmon
77

8-
A macOS menu bar application that displays live air quality data from the nearest sensor station. It can also notify you when the air quality index changes or when a new, closer station is found.
8+
Airqmon is a macOS menu bar application that displays live air quality data from the nearest sensor station. It can also notify you when the air quality index changes or when a new, closer station is found.
99

1010
<p align="center">
1111
<img width="492" align="center" alt="Airqmon window with measurement details" src="https://airqmon.app/assets/[email protected]" />
@@ -19,7 +19,11 @@ A macOS menu bar application that displays live air quality data from the neares
1919

2020
- [Airly][airly] - over 20k sensor stations in many cities around the world in addition to data provided from third-party services like PurpleAir. Check the [Airly map][airly-map] for full coverage.
2121

22-
**Disclaimer:** Airqmon API is using my own personal [Airly][airly] API key, which falls under the general [Airly free usage rate limits][airly-pricing]. When inquired about increasing the limits to sustain the rising number of Airqmon's users, Airly asked me in return to sign a legally binding contract. Due to the nature of this project, I am unable to comply with this demand. As a result, Airqmon will stop displaying air quality data at a certain user threshold, or the displayed data will be outdated.
22+
## Source code-only
23+
24+
Due to the reasons described in [this comment](https://github.com/jsynowiec/airqmon/issues/50#issuecomment-1008751034), I am no longer willing to cover the monthly costs associated with the Airqmon API and Google Geolocation.
25+
26+
I have removed all binaries from the current and previous releases as they will no longer work. You can host the Airqmon API on your own and clone the latest release to build your version of the app.
2327

2428
## Build & installation
2529

@@ -34,37 +38,15 @@ There are a few options available to customize on the preferences window that yo
3438

3539
## Airqmon API
3640

37-
From version 2, Airmoqn uses the Airmon API, a companion service, to find the nearest station and fetch measurements.
38-
39-
## FAQ
40-
41-
### macOS doesn't allow me to start the app
42-
43-
Since macOS Sierra, if you try to open an app that is not registered with Apple by an identified developer you get a warning dialog. Airqmon is not signed nor was submitted to Apple for review.
44-
45-
<p align="center">
46-
<img width="372" alt="Screenshot 2021-03-02 at 10 02 17" src="https://user-images.githubusercontent.com/1029142/109624419-7cfbd600-7b3e-11eb-8651-3737b93d2641.png">
47-
</p>
48-
49-
To override your security settings and open the app:
41+
From version 2, Airqmon uses the [Airmon API][airqmon-api], a supplementary service, to find the nearest station and fetch measurements.
5042

51-
1. In the Finder, locate the app you want to open.
52-
2. Control-click the app icon, then choose Open from the shortcut menu.
43+
## Geolocation
5344

54-
Read more: [PH25088](https://support.apple.com/kb/PH25088?locale=en_US)
45+
From version 2.1.1, Airqmon uses the free ip-api.com for geolocation. If you want to switch back to the Google Geolocation API, revert the relevant changes from the [1fe51d](https://github.com/jsynowiec/airqmon/commit/1fe51d966f15caeeca1e6385d01b96c6e266210c) commit.
5546

5647
## Privacy
5748

58-
Airqmon application does not track any personal identifiable information or usage analytics.
59-
60-
## Sponsors
61-
62-
<p>This project is supported by:</p>
63-
<p>
64-
<a href="https://m.do.co/c/38582030d6df">
65-
<img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="201px">
66-
</a>
67-
</p>
49+
Airqmon application does not track any personally identifiable information or usage analytics.
6850

6951
### Credits
7052

@@ -80,6 +62,7 @@ This app is an open-source software licensed under the [Apache License, Version
8062

8163
[license]: https://raw.githubusercontent.com/jsynowiec/airqmon/main/LICENSE
8264
[airqmon-latest-release]: https://github.com/jsynowiec/airqmon/releases/latest
65+
[airqmon-api]: https://github.com/jsynowiec/airqmon-api
8366
[gh-actions]: https://actions-badge.atrox.dev/jsynowiec/airqmon/goto?ref=main
8467
[badge-github-release]: https://img.shields.io/github/release/jsynowiec/airqmon.svg
8568
[badge-license]: https://img.shields.io/github/license/jsynowiec/airqmon.svg

0 commit comments

Comments
 (0)