From ab66c05aef442841db230a28c047ff5b6d0697e1 Mon Sep 17 00:00:00 2001
From: Artemiy <kolobov-artem@bk.ru>
Date: Fri, 2 May 2025 20:31:34 +0500
Subject: [PATCH] =?UTF-8?q?=D0=93=D0=B5=D0=BD=D0=B5=D1=80=D0=B0=D1=86?=
 =?UTF-8?q?=D0=B8=D1=8F=20Readme.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 169 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 169 insertions(+)

diff --git a/README.md b/README.md
index 783746f..25b3c12 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,173 @@
 # Bot_of_Pray
+Telegram-бот для молитвенного поминания
+Описание проекта
+
+Бот предоставляет пользователям возможность отправлять имена для молитвенного поминания священнику. Система позволяет добавлять имена в разные типы записок, оставлять комментарии и управлять своими записями.
+Основные функции
+
+    Типы записок:
+
+        О здравии
+
+        За упокой
+
+        Комментарии
+
+    Управление записями:
+
+        Просмотр текущих записей
+
+        Добавление новых имен
+
+        Очистка записей
+
+        Сохранение изменений
+
+    Админ-панель:
+
+        Получение уведомлений о новых записях
+
+        Статистика использования
+
+        Управление записями
+
+Архитектура проекта
+
+    Структура папок:
+
+        handlers/ - обработчики команд и callback-запросов
+
+        utils/ - вспомогательные функции
+
+        messages.py - текстовые сообщения
+
+        main.py - точка входа приложения
+
+        prefixes.json - файл с префиксами
+
+        requirements.txt - зависимости проекта
+
+Основные компоненты
+
+    Обработчики:
+
+        Пользовательские команды
+
+        Callback-запросы
+
+        Админ-команды
+
+        Базовые функции
+
+    Утилиты:
+
+        Работа с базой данных
+
+        Форматирование сообщений
+
+        Отправка уведомлений
+
+        Логирование
+
+Требования и установка
+
+    Необходимые зависимости:
+
+        Python 3.8+
+
+        Python-telegram-bot
+
+        Дополнительные библиотеки из requirements.txt
+
+Настройка и запуск
+
+    Настройка окружения:
+
+        Создайте файл .env с необходимыми переменными:
+
+    TELEGRAM_TOKEN_FILE=path/to/token.txt
+    TELEGRAM_DATABASE=path/to/database.json
+    TELEGRAM_ADMINS=path/to/admins.txt
+
+Установка зависимостей:
+
+pip install -r requirements.txt
+
+Запуск бота:
+
+    python main.py
+
+Структура данных
+
+    База данных:
+
+        Хранится в формате JSON
+
+        Структура:
+
+        {
+          "user_id": {
+            "О здравии": ["имя1", "имя2"],
+            "За упокой": ["имя1", "имя2"],
+            "Комментарий": "текст комментария"
+          }
+        }
+
+Развертывание
+
+    Рекомендации:
+
+        Используйте Docker для деплоя
+
+        Настройте мониторинг состояния бота
+
+        Добавьте систему автоматического перезапуска
+
+        Обеспечьте регулярное резервное копирование данных
+
+Поддержка и развитие
+
+    Документация:
+
+        Все основные функции документированы в коде
+
+        Добавлены комментарии к критическим участкам
+
+    Тестирование:
+
+        Реализовано базовое логирование ошибок
+
+        Добавлены проверки корректности данных
+
+Контактная информация
+
+    Поддержка:
+
+        Для вопросов и предложений обращайтесь к разработчикам
+
+Лицензирование
+
+    Лицензия:
+
+        MIT License
+
+История изменений
+
+    Версия 1.0:
+
+        Базовая функциональность
+
+        Система уведомлений
+
+        Управление записями
+
+        Админ-панель
+
+Благодарности
+
+    Команда разработчиков:
+
+        Благодарим всех участников проекта за вклад в развитие бота