Skip to content

Commit

Permalink
feat: Add command line options to readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewjw committed Jul 8, 2023
1 parent 9039f6e commit 01771cd
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,14 @@
[![Pipeline](https://github.com/andrewjw/breakout-garden-exporter/actions/workflows/build.yml/badge.svg)](https://github.com/andrewjw/breakout-garden-exporter/actions/workflows/build.yml) ![PyPI](https://img.shields.io/pypi/v/breakout-garden-exporter) [![Coverage Status](https://coveralls.io/repos/github/andrewjw/breakout-garden-exporter/badge.svg?branch=main)](https://coveralls.io/github/andrewjw/breakout-garden-exporter?branch=master)

Exposes Prometheus metrics from sensors that are part of [Pimoroni's Breakout Garden family](https://shop.pimoroni.com/collections/breakout-garden).

```
usage: breakout-garden-exporter [-h] [-q] [--bind [BIND]]
Exposes Prometheus metrics from sensors that are part of Pimoroni's Breakout Garden family
optional arguments:
-h, --help show this help message and exit
-q, --quiet don't log HTTP requests
--bind [BIND] the ip address and port to bind to. Default: *:9101
```

0 comments on commit 01771cd

Please sign in to comment.