From f01c6ebac06a16817604ec9dd5a2af7d337793f7 Mon Sep 17 00:00:00 2001
From: Knut Ahlers <knut@ahlers.me>
Date: Sun, 5 Jul 2020 01:51:07 +0200
Subject: [PATCH] Document config format

Signed-off-by: Knut Ahlers <knut@ahlers.me>
---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/README.md b/README.md
index 02063e5..3d61e08 100644
--- a/README.md
+++ b/README.md
@@ -10,3 +10,39 @@
 
 - Settings defined in the config are fetched through MQTT
 - If the setting does not match an update is issued as `BackLog` command
+
+## Example config
+
+```yaml
+---
+
+settings:
+  TelePeriod: 30
+  Timezone: +00:00
+
+devices:
+
+  bedroom:
+    topic: bedroom
+    settings:
+      DeviceName: Bedroom Sensor
+      Module: 0
+      Template: '{"NAME":"DevRoom 1 Mov 1 BME","GPIO":[0,0,0,0,6,5,0,0,0,0,9,0,0],"FLAG":0,"BASE":19}'
+
+  fridge:
+    topic: fridge
+    settings:
+      DeviceName: Fridge
+      Module: 6
+      PowerCal: 13769
+      VoltageCal: 2127
+
+  phonecharge:
+    topic: phonecharge
+    settings:
+      DeviceName: Phone Charger
+      LedState: 0  # Don't shine on my during night
+      Module: 8
+
+...
+```