Create README.md

IlyaGusev · Jul 8, 2024 · d45928c · d45928c
1 parent 223123b
commit d45928c
Showing 1 changed file with 43 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,43 @@
+# Saiga: Telegram bot
+
+## Description
+
+This is a Telegram bot designed to interact with various language models. It offers support for system prompts and image processing capabilities.
+
+## Features
+
+- Integration with Telegram platform
+- Support for any number of language models (compatible with OpenAI API format)
+- Ability to handle system prompts, generation parameters, and characters
+- Image processing and generation (with DALL-E)
+- Function calling with a set of basic tools
+
+## Installation
+
+To install and run the bot, follow these steps:
+
+1. Clone the repository:
+```
+git clone https://github.com/IlyaGusev/saiga_bot
+```
+
+2. Navigate to the project directory:
+```
+cd saiga_bot
+```
+
+3. Install the required dependencies (you may need to create a virtual environment first):
+```
+pip3 install -r requirements.txt
+```
+
+4. Add a token from [@BotFather](https://t.me/botfather) and an admin's user name and ID to [configs/bot.json](https://github.com/IlyaGusev/saiga_bot/blob/master/configs/bot.json).
+5. Add URLs and tokens to [configs/providers.json](https://github.com/IlyaGusev/saiga_bot/blob/master/configs/providers.json)
+6. Run the bot with [run.sh](https://github.com/IlyaGusev/saiga_bot/blob/master/run.sh):
+```
+./run.sh configs/bot.json db.sqlite
+```
+
+## Contact
+
+For any questions or feedback, please open an issue on the GitHub repository or contact [@YallenGusev](https://t.me/YallenGusev).