From e7c719312fa0e79f312f82bd488897d1e9b27dcc Mon Sep 17 00:00:00 2001
From: profitroll <profitroll@end-play.xyz>
Date: Tue, 6 May 2025 20:24:02 +0200
Subject: [PATCH] Completed the README documentation for #4

---
 README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 58 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 46f9085..024a1c4 100644
--- a/README.md
+++ b/README.md
@@ -37,7 +37,64 @@ Open source Discord bot for quizzes and quest-like events.
 
 ## Configuration
 
-TODO
+```json
+{
+    "locale": "en-US",
+    // Bot's default locale. Based on file name from locale/
+    "debug": false,
+    // Debug mode setting
+    "bot": {
+        "owners": [
+            0
+            // Discord ID of bot's owner
+        ],
+        "debug_guilds": [
+            0
+            // Discord ID of the debug guild
+        ],
+        "bot_token": "",
+        // Bot's token
+        "timezone": "UTC",
+        // Bot's timezone
+        "status": {
+            "enabled": true,
+            // Whether activity is enabled
+            "activity_type": "playing",
+            // Type of the activity. Can be: playing, watching, listening, streaming, competing and custom
+            "activity_text": "The Game Of Life"
+            // Text of the activity
+        }
+    },
+    "database": {
+        "user": null,
+        // User name for database connection. null if without auth
+        "password": null,
+        // User password for database connection. null if without auth
+        "host": "127.0.0.1",
+        // Database host
+        "port": 27017,
+        // Database port
+        "name": "quiz_bot"
+        // Database name
+    },
+    "cache": {
+        "type": null,
+        // Type of caching engine. Can be: memcached and redis
+        "memcached": {
+            "uri": "127.0.0.1:11211"
+            // Memcached URI
+        },
+        "redis": {
+            "uri": "redis://127.0.0.1:6379/0"
+            // Redis URI
+        }
+    },
+    "emojis": {
+        "guess_wrong": null
+        // Markdown of a Discord emoji to be used for wrong guesses
+    }
+}
+```
 
 ## Upgrading