diff --git a/README.md b/README.md index ddc1bcb1..53689028 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,17 @@ -# Prometheus Weathermen +# Prometheus Weathermen [![Build Pipeline](https://github.com/lstrojny/prometheus-weathermen/actions/workflows/build.yml/badge.svg)](https://github.com/lstrojny/prometheus-weathermen/actions/workflows/build.yml) -> You don't need a weatherman to know which way the wind blows — Bob Dylan, Subterranean Homesick Blues +
“You don't need a weatherman to know which way the wind blows”
       — Bob Dylan, Subterranean Homesick Blues
A prometheus exporter endpoint for weather data or my excuse to do some Rust for real. - ### What it does -Provides a Prometheus metrics endpoint on `:36333/metrics` and serves the following metrics for configured +Provides a Prometheus metrics endpoint on `:36333/metrics` and serves the following metrics for configured location from each configured provider: - * `weather_temperature_celsius` - * `weather_relative_humidity` (not yet implemented) + +- `weather_temperature_celsius` +- `weather_relative_humidity` (not yet implemented) ### Configuration + Check [weathermen.toml.dist](weathermen.toml.dist) for configuration options.