Skip to content

Commit

Permalink
README cosmetics
Browse files Browse the repository at this point in the history
  • Loading branch information
lstrojny committed Jan 9, 2023
1 parent 060d1b9 commit 2d65bfc
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
<font size=4><blockquote><em>“You don't need a weatherman to know which way the wind blows”</em><br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;— Bob Dylan, Subterranean Homesick Blues</blockquote></font>

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 `<host>:36333/metrics` and serves the following metrics for configured
Provides a Prometheus metrics endpoint on `<host>: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.

0 comments on commit 2d65bfc

Please sign in to comment.