diff --git a/readme.md b/readme.md index 6f59ee0..531b4dc 100644 --- a/readme.md +++ b/readme.md @@ -1,5 +1,7 @@ # mqtt2statsd +mqtt2statsd is a service that translates numeric MQTT messages into statsd gauge metrics. + ## Dependencies Ubuntu: @@ -10,3 +12,8 @@ pkg-config \ cmake \ gcc ``` + +## Configuration + +mqtt2statsd is configured via a toml configuration file. +Check [example.toml](./example.toml) for an example configuration.