Логи. Уведомления. Тексты

README.md

@@ -6,7 +6,7 @@
 
 ## 📋 Оглавление
 1. [Описание](#Описание)
-2. [Требования](#Требования)
+2. [Стек технологий](#Стек)
 3. [Установка](#установка)
 4. [Конфигурация](#конфигурация)
 5. [Запуск](#запуск)
@@ -16,20 +16,44 @@
 
 ## 📖 Описание
 
-Бот предназначен для автоматизирования выдачи ключей, хранении их в базе данных и управления подключениями.
-Также реализованы функции смены локации, автоматических и ручных уведомлений
+Бот реализует такие функции:
 
+- выдача ключей на пробный период
+- выдача ключей на период 1мес/3мес/полгода/год
+- продление ключей на эти периоды
+- клиент может полностью руководить своим ключом:
+  * удаление 
+  * продление 
+  * просмотр информации (сервер, сколько осталось, сам ключ) 
+- смена локации (ключ перемещается с одного сервера на другой)
+- клиент может иметь несколько ключей (несколько устройств)
+- реферальная программа по пригласительной ссылке
+- инструкции
+- пополнение баланса через сервис Юкасса
+- периодические бэкапы базы данных клиентов
+- функции уведомлений:
+  * произвольные: можно через админку отправить любое информационное сообщение
+  * о не использованном пробнике
+  * о истекающих ключах (за сутки/6 часов/момент истечения)
+- чат поддержки/канал/
+- автоматическое продление ключа, если у клиента есть баланс на нужную сумму
 
 ---
 
-## 💻 Требования
+## 💻 Стек
 
-Для работы проекта необходимы следующие компоненты:
+Проект использует следущие компоненты
 
 - **Python** версии 3.8 или выше
 - **Git** для клонирования репозитория
 - **Virtualenv** для создания виртуального окружения (рекомендуется)
-- **postgresql** для работы базы данных
+- **postgresql** база данных
+- **nginx** для работы с нужными вебхуками
+- **aiogram** используется новейшая версия 3.13
+- **youkassa** для работы с кассой
+- **aiohttp** для api запросов к панелям
+
+Проект полностью асинхронный, что обеспечивает высокую скорость работы
 
 ---
 
@@ -85,6 +109,8 @@ WEBHOOK_HOST = адрес вашего сервера для вебхуков
 WEBHOOK_PATH = '/webhook/' 
 WEBHOOK_URL = f"{WEBHOOK_HOST}{WEBHOOK_PATH}"
 SUPPORT_CHAT_URL = ваша ссылка на поддержку 
+
+полная версия конфигурации доступна через поддержку нашего бота
 ```
 
 ### 🚀 Запуск