From 2c2545fafb3b50ef6a45f1673f19027c93cbac10 Mon Sep 17 00:00:00 2001
From: "Gleb O. Ivaniczkij" <csasq@csasq.ru>
Date: Wed, 14 Aug 2024 00:06:43 +0300
Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB=D0=B5?=
 =?UTF-8?q?=D0=BD=D0=BE=20=D0=BE=D0=BF=D0=B8=D1=81=D0=B0=D0=BD=D0=B8=D0=B5?=
 =?UTF-8?q?=20=D0=BF=D1=80=D0=BE=D0=B5=D0=BA=D1=82=D0=B0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8dac0a8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# CIT IS Bot
+
+![Static Badge](https://img.shields.io/badge/Powered%20by-csasq-blue)
+![Static Badge](https://img.shields.io/badge/Python-3.9%2B-blue)
+![Static Badge](https://img.shields.io/badge/License-CC%20BY--NC%204.0-blue)
+
+Telegram чат-бот для создания периодических опросов и цепочек опросов в групповых чатах ГАУ ТО «ЦИТ» управления информационных систем.
+
+## Возможности
+
+- [x] Периодические опросы о текущем состоянии сотрудников;
+- [x] Периодические опросы о планах на обеденный перерыв;
+- [ ] Веб-приложение для управления чат-ботом #2.
+
+## Быстрый старт
+
+Установите библиотеки, необходимые для запуска приложения.
+
+```bash
+pip install -r requirements.txt
+```
+
+Создайте файл конфигурации.
+
+```ini
+[Main]                  # Основные настройки
+host = localhost        # IP-адрес или имя хоста веб-приложения
+port =                  # Порт веб-приложения
+title = CIT IS Bot      # Заголовок веб-приложения
+
+[PostgreSQL]            # Настройки подключения к PostreSQL
+host = localhost        # IP-адрес или имя хоста
+port = 5432             # Порт
+user =                  # Имя пользователя
+password =              # Пароль пользователя
+dbname =                # Имя базы данных
+
+[Redis]                 # Настройки подключения к Redis
+host = localhost        # IP-адрес или имя хоста
+port = 6379             # Порт
+db =                    # Номер базы данных
+password =              # Пароль сервера (если установлен)
+
+[Telegram]              # Настройки Telegram Bot API
+token =                 # Токен чат-бота, полученный у @BotFather
+```