From 634a9dfc9d6f415f802fdcd9810c6396510d7f7d Mon Sep 17 00:00:00 2001
From: Artemiy <kolobov-artem@bk.ru>
Date: Sat, 3 May 2025 03:08:21 +0500
Subject: [PATCH] Edit README.md

---
 README.md | 63 ++++++++++++++++++++++++++++++++++---------------------
 1 file changed, 39 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index 661fb6a..ef09e17 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@
 * Очистка записей
 * Сохранение изменений
 
-###Админ-панель:
+### Админ-панель:
 * Получение уведомлений о новых записях
 * Статистика использования
 * Управление записями
@@ -45,14 +45,35 @@
 
 ## Требования и установка
 
-###Необходимые зависимости:
+### Необходимые зависимости:
 
 * Python 3.8+
 * Python-telegram-bot
 * Дополнительные библиотеки из requirements.txt
+Настройка и запуск
 
 ## Настройка и запуск
 
+###Контейнеризация проекта
+
+Проект реализован с использованием Docker Compose. Конфигурация описана в файле docker-compose.yaml:
+```yaml
+services:
+  telegram-bot:
+    image: python
+    volumes:
+      - ./python-bot:/usr/src/app
+      - ./secrets:/usr/src/app/secrets
+      - ./requirements.txt:/usr/src/app/requirements.txt
+    working_dir: /usr/src/app
+    command: python main.py
+    environment:
+      - TELEGRAM_TOKEN_FILE=/usr/src/app/secrets/token.txt
+      - TELEGRAM_DATABASE=/usr/src/app/data.json
+      - TELEGRAM_ADMINS=/usr/src/app/secrets/admins.txt
+    entrypoint: ["sh", "-c", "export PIP_ROOT_USER_ACTION=ignore && pip install -r /usr/src/app/requirements.txt && pip install --upgrade pip && python main.py"]
+```
+
 ### Настройка окружения:
 * Создайте файл .env с необходимыми переменными:
 ```bash
@@ -61,22 +82,22 @@
     TELEGRAM_ADMINS=path/to/admins.txt
 ```
 
-###Установка зависимостей:
+### Установка зависимостей:
 ```bash
 pip install -r requirements.txt
 ```
-###Запуск бота:
+### Запуск бота:
 ``` bash
     python main.py
 ```
 
-##Структура данных
+## Структура данных
 
-**База данных: **
+### База данных:
 
         Хранится в формате JSON
 
-###        Структура:
+### Структура:
 ```
         {
           "user_id": {
@@ -86,44 +107,44 @@ pip install -r requirements.txt
           }
         }
 ```
-##Развертывание
+## Развертывание
 
-###    Рекомендации:
+### Рекомендации:
 
 * Используйте Docker для деплоя
 * Настройте мониторинг состояния бота
 * Добавьте систему автоматического перезапуска
 * Обеспечьте регулярное резервное копирование данных
 
-Поддержка и развитие
+## Поддержка и развитие
 
-    Документация:
+###    Документация:
 
         Все основные функции документированы в коде
 
         Добавлены комментарии к критическим участкам
 
-    Тестирование:
+###    Тестирование:
 
         Реализовано базовое логирование ошибок
 
         Добавлены проверки корректности данных
 
-Контактная информация
+## Контактная информация
 
-    Поддержка:
+    ### Поддержка:
 
         Для вопросов и предложений обращайтесь к разработчикам
 
-Лицензирование
+## Лицензирование
 
     Лицензия:
 
-        MIT License
+        GPL3.0
 
-История изменений
+## История изменений
 
-    Версия 1.0:
+###    Версия 1.0:
 
         Базовая функциональность
 
@@ -133,11 +154,5 @@ pip install -r requirements.txt
 
         Админ-панель
 
-Благодарности
-
-    Команда разработчиков:
-
-        Благодарим всех участников проекта за вклад в развитие бота
-