From f1740ce4c0512556110e3e532d35c5961cd9688a Mon Sep 17 00:00:00 2001
From: Ceda EI <ceda_ei@webionite.com>
Date: Tue, 28 Sep 2021 14:54:05 +0530
Subject: [PATCH] Update README

---
 README.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d665b9d..df66af6 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,16 @@
 # Quadnite-Bot
-Source code for @quadnite_bot
+
+Source code for [@quadnite\_bot](https://t.me/quadnite_bot)
+
+## Running your own instance
+
+Quadnite bot depends on [Ugoki](https://gitlab.com/ceda_ei/ugoki) for providing
+roleplay gifs. Once you have an instance of Ugoki (and optionally
+[Ugoki Frontend](https://gitlab.com/ceda_ei/ugoki-frontend)) running:
+
+- Clone this repo
+- `npm install`
+- `export BOT_API_KEY="your-token-for-bot"`
+- `export FEEDBACK_ID="chat-id-where-feedback-is-forwarded-to"`
+- `export UGOKI_ROOT="https://root.of.ugoki.api/server/"`
+- `npm start`