From 470a05018ee03854514dcddd2dfd859900c913b8 Mon Sep 17 00:00:00 2001 From: Vladless Date: Sat, 26 Oct 2024 02:18:48 +0300 Subject: [PATCH] ReadMe --- README.md | 72 +++++++++++++++++++++++++++---------------------------- 1 file changed, 35 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 687fcc8e..2e1d70e4 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,57 @@ # 🚀 SoloBot -**SoloBot**! -Бот для API 3x-UI VPN на протоколе vless -Бот для vless +**SoloBot** — ваш идеальный помощник для управления API 3x-UI VPN на протоколе VLESS. ## 📋 Оглавление -1. [Описание](#Описание) -2. [Стек технологий](#Стек) +1. [Описание](#описание) +2. [Стек технологий](#стек-технологий) 3. [Установка](#установка) 4. [Конфигурация](#конфигурация) 5. [Запуск](#запуск) -6. [Автор](#SoloBot) +6. [Контакты](#контакты) --- ## 📖 Описание -Бот реализует такие функции: +SoloBot реализует множество функций, включая: -- выдача ключей на пробный период -- выдача ключей на период 1мес/3мес/полгода/год -- продление ключей на эти периоды -- клиент может полностью руководить своим ключом: - * удаление - * продление - * просмотр информации (сервер, сколько осталось, сам ключ) -- смена локации (ключ перемещается с одного сервера на другой) -- клиент может иметь несколько ключей (несколько устройств) -- реферальная программа по пригласительной ссылке -- инструкции -- пополнение баланса через сервис Юкасса -- периодические бэкапы базы данных клиентов -- функции уведомлений: - * произвольные: можно через админку отправить любое информационное сообщение - * о не использованном пробнике - * о истекающих ключах (за сутки/6 часов/момент истечения) -- чат поддержки/канал/ -- автоматическое продление ключа, если у клиента есть баланс на нужную сумму +- **Выдача ключей на пробный период**. +- **Выдача ключей на длительные периоды** (1 месяц, 3 месяца, полгода, год). +- **Продление ключей** на указанные периоды. +- Полный контроль клиента над своими ключами: + - Удаление ключей. + - Продление ключей. + - Просмотр информации о ключе (сервер, оставшееся время, сам ключ). +- **Смена локации** (перемещение ключа между серверами). +- Поддержка нескольких ключей для одного клиента (несколько устройств). +- **Реферальная программа** с пригласительной ссылкой. +- Доступ к **инструкциям**. +- **Пополнение баланса** через сервис Юкасса. +- Периодические **бэкапы базы данных клиентов**. +- Уведомления: + - Произвольные сообщения через админку. + - Уведомления о неиспользованных пробниках. + - Уведомления о истекающих ключах (за сутки, за 6 часов и в момент истечения). +- **Чат поддержки** и канал для связи. +- **Автоматическое продление ключа** при наличии достаточного баланса. --- -## 💻 Стек +## 💻 Стек технологий -Проект использует следущие компоненты +Проект использует следующие технологии: -- **Python** версии 3.8 или выше -- **Git** для клонирования репозитория -- **Virtualenv** для создания виртуального окружения (рекомендуется) -- **postgresql** база данных -- **nginx** для работы с нужными вебхуками -- **aiogram** используется новейшая версия 3.13 -- **youkassa** для работы с кассой -- **aiohttp** для api запросов к панелям +- **Python** версии 3.8 или выше. +- **Git** для клонирования репозитория. +- **Virtualenv** для создания виртуального окружения (рекомендуется). +- **PostgreSQL** для хранения данных. +- **Nginx** для работы с вебхуками. +- **aiogram** (версия 3.13) для взаимодействия с Telegram API. +- **youkassa** для обработки платежей. +- **aiohttp** для API запросов к панелям. -Проект полностью асинхронный, что обеспечивает высокую скорость работы +Проект полностью асинхронный, что обеспечивает высокую скорость работы. ---