From b10ba230e4baf074a1e9beb61c756fd5e974d04b Mon Sep 17 00:00:00 2001
From: Humaun Kabir <ask.humaunkabir@gmail.com>
Date: Sat, 5 Oct 2024 03:24:33 +0300
Subject: [PATCH] Create README.md

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0350706
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+### tg-finbot
+
+A telegram bot to receive texts, images or pdfs and answer questions accordingly using LLMs.
+
+#### Installation
+Install dependencies through pip
+```
+pip install -r requirements.txt
+```
+
+#### Configuring a Telegram bot
+On Telegram hit to [@BotFather](https://t.me/BotFather) initiate your own bot and obtain ```BOT_TOKEN, BOT_USER```.
+
+Example ```config/config.py``` with necessary keys and values.
+```python
+from typing import Final
+
+BOT_TOKEN: Final = 'yourbottoken'
+BOT_USER: Final = '@username'
+APIURL: Final = 'llmapiendpoint'
+VLLM: Final = 'mistral-nemo'
+BEARER: Final = "Bearer bearertokenhere"
+```
+
+#### Backend
+Run the backend of bot by
+```
+python main.py
+```
+Output
+```
+Bot started...
+Bot polling...
+```
+
+#### Example Usage
+Once your bot is running as well as your API is serving properly. Start interacting with your bot.