From e9f166ee1b206adc42c750bd93fcf8f25a93697b Mon Sep 17 00:00:00 2001
From: Sijmen Schoon <sijmenschoon@gmail.com>
Date: Tue, 15 Nov 2016 07:45:09 +0100
Subject: [PATCH] Add a bit more documentation

---
 README.md           | 20 +++++++++++++++++++-
 config.json.example |  4 ----
 2 files changed, 19 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index dc8076c..dbdbf19 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,25 @@ pip install -r requirements.txt
 ```
 
 ### Configuration
-TODO
+**telematrix configuration**
+
+First, copy config.json.example to config.json. Then fill in the fields:
+
+`tokens.hs`: A randomly generated token
+`tokens.as`: Another randomly generated token
+`tokens.telegram`: The Telegram bot API token, as generated by @BotFather
+`tokens.google`: A Google API key, used for URL shortening. Can be left out to disable.
+
+`hosts.internal`: The homeserver host to connect to internally.
+`hosts.external`: The external domain of the homeserver, used for generating URLs.
+`hosts.bare`: Just the (sub)domain of the server.
+
+`user_id_format`: A Python `str.format`-style string to format user IDs as
+`db_url`: A SQLAlchemy URL for the database. See the [SQLAlchemy docs](http://docs.sqlalchemy.org/en/latest/core/engines.html).
+
+**Synapse configuration**
+
+*TODO*
 
 ## Contributions
 
diff --git a/config.json.example b/config.json.example
index e2f1c9c..263027d 100644
--- a/config.json.example
+++ b/config.json.example
@@ -12,10 +12,6 @@
         "bare": "DOMAIN.TLD"
     },
 
-    "chats": {
-        "-TELEGRAM_ID": "!INTERNAL_ID:DOMAIN.TLD"
-    },
-
     "user_id_format": "@telegram_{}:DOMAIN.TLD",
     "db_url": "sqlite:///database.db"
 }