From 3a27015d47fef9502a0cf152eb7481e931e14bbb Mon Sep 17 00:00:00 2001
From: n0m1s <git@homnomnom.fr>
Date: Tue, 19 Sep 2023 18:28:54 -0700
Subject: [PATCH] update readme

---
 readme.md | 7 +++++++
 1 file changed, 7 insertions(+)

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.