diff --git a/README.md b/README.md index 8c677a2..223dfcc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Purple Air Scraper +# Purple Air Exporter A Prometheus extractor for PurpleAir sensor data using the PurpleAir API. This script queries the PurpleAir API (api.purpleair.com) for public sensor(s) and captures the data as Prometheus metrics. Most other implementations of similar extractors I found were using outdated methods of gathering this data (the old /json endpoint was shut down in 2022, and the map.purpleair.com method feels like a hack. Additionally, the official API offers an endpoint to query multiple sensors in a single request. The following fields are mapped directly from the API response: