document, CITADEL -> MATRIX

1 files changed, 18 insertions, 0 deletions

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
+```