From 6f6647cf2e9079137099b9ca2683919a87f03331 Mon Sep 17 00:00:00 2001
From: makefu <github@syntax-fehler.de>
Date: Sat, 15 Aug 2020 14:31:51 +0200
Subject: document, CITADEL -> MATRIX

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 54b5c22..3a34442 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,21 @@ Kalauerbot
 ==========
 
 Manage the list of kalauer königs
+
+
+Usage
+====
+
+```
+# Mandatory environment variables
+MATRIX_TOKEN="abcd"
+MATRIX_ID="@user:matrix.org"
+
+# Optional environment variables
+MATRIX_SERVER="matrix.org"
+KALAUER_DBPATH="/var/lib/kalauer.json"
+KALAUER_WHITELIST="!channel1,!channel2"
+
+# now run:
+kalauerbot
+```
-- 
cgit v1.2.3