From 33cb728d39e439aef91d58c9bd9d44a708c1072d Mon Sep 17 00:00:00 2001
From: Aditya Ningule <adiningule2@gmail.com>
Date: Sat, 18 May 2024 23:44:07 +0530
Subject: [PATCH] docs: envars docs (#802)

---
 README.md | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 7c5c1787..123da29d 100644
--- a/README.md
+++ b/README.md
@@ -15,8 +15,25 @@ Copy `.env.example` to `.env` and add your private information
 *Note: never commit this file, it is ignored by Git*
 
 ```
-DISCORD_TOKEN="<your-token>"
-EDDIEBOT_MONGO_CONNECTION_STRING="<your-mongo-connection-string>"
+# .env file
+
+# required: discord API token
+DISCORD_TOKEN=
+
+# required: mongo URL connection string
+EDDIEBOT_MONGO_CONNECTION_STRING=
+
+# optional
+DEBUG_HOOK=
+
+# required: discord server id
+HOME_GUILD="699608417039286293"
+
+# optional
+NODE_ENV="development"
+
+# required: channel id for logs
+ADMIN_CHANNEL=
 ```
 
 ## Installation