summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2021-01-03 18:17:12 +0100
committerMatthias Beyer <mail@beyermatthias.de>2021-01-03 19:51:04 +0100
commit4d2a42e374fb42a4e5e4d91b85023ddd96e51aaf (patch)
treef46f2c2ba7acf7df507aaf4cfb71192d276340b1
parenta45213146476f3d45c13d05b2f9467607008b861 (diff)
Add usage exampleHEADv0.1.0master
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index d201730..9181d81 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,20 @@
Export MPD server metrics to prometheus.
+## Usage
+
+```
+RUST_LOG=info \
+prometheus-mpd-exporter \
+ --mpd-server-addr 127.0.0.1 \
+ --mpd-server-port 6600 \
+ --bind-addr <address to bind to, e.g. 0.0.0.0> \
+ --bind-port <port to bind to, e.g. 9123>
+```
+
+And then start scraping with prometheus.
+
+
## License
GPLv2.0 only