Skip to content

Commit

Permalink
Update provider information, explain installation
Browse files Browse the repository at this point in the history
  • Loading branch information
lstrojny committed Jan 12, 2023
1 parent 3450207 commit f00c587
Showing 1 changed file with 33 additions and 4 deletions.
37 changes: 33 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,40 @@ location from each configured provider:

### Supported providers

The following services are implemented as providers. Each configured provider is queries for weather information.
The following services are implemented as providers. Each configured provider is queried for weather information.

- [Meteoblue](https://www.meteoblue.com/)
- [OpenWeather](https://openweathermap.org/)
- [tomorrow.io](https://www.tomorrow.io/)
| Provider | Resolution | Coverage | Supports humidity | Registration required |
| --------------------------------------------- | ---------- | --------- | ----------------- | --------------------- |
| [Meteoblue](https://www.meteoblue.com/) | High | Worldwide || Yes |
| [OpenWeather](https://openweathermap.org/) | Medium | Worldwide || Yes |
| [tomorrow.io](https://www.tomorrow.io/) | High | Worldwide || Yes |
| [Deutscher Wetterdienst](https://www.dwd.de/) | Medium | Germany || No |

You need to register an account for those providers that require an API key.

### Installation

Go to [the latest release](https://github.com/lstrojny/prometheus-weathermen/releases/latest) and download the
appropriate binary for your platform.

The following platforms are supported:

| Platform | Use case |
| ------------ | --------------------------------- |
| arm-linux | 32 bit armhf, e.g. Raspberry Pi |
| arm64-linux | 64 bit arm, Raspberry Pi 4 |
| x86_64-linux | 64 bit X86 architecture for Linux |
| intel-mac | Intel based Macs |
| arm-mac | M1/M2 based ARM Macs |

Please open an issue if your favorite platform is missing. It’s probably not terribly much work to get it going.

There are `dbg` (debug) variants of the binaries. These are unstripped debug builds. If you don’t know what that is, you
don’t want it.

For the Linux builds, `static` variants based on [musl libc](https://www.musl-libc.org/) are available. These are
statically linked binaries that can be used to run `prometheus-weathermen` in a container with minimal fuzz. The non-static
counterparts for Linux are build against glibc.

### Configuration

Expand Down

0 comments on commit f00c587

Please sign in to comment.