Update README.md

README.md

@@ -1 +1,69 @@
-# amnezia-bot
+# AmneziaVPN Telegram Bot
+
+Телеграм-бот на Python для управления [AmneziaVPN](https://github.com/amnezia-vpn/amnezia-client). Этот бот позволяет легко управлять клиентами.  
+
+Используется библиотека `aiogram` версии 2.25.2.  
+Протестировано на Ubuntu, версии 20.04, 22.04, 24.04.
+
+## Оглавление
+
+- [Возможности](#возможности)
+- [Установка](#установка)
+- [Запуск](#запуск)
+- [Заметки](#заметки)
+- [Поддержка](#поддержка)
+
+## Возможности
+
+- Добавление клиентов
+- Удаление клиентов
+- Создание временных конфигураций (1 час, 1 день, 1 неделя, 1 месяц, без ограничений)
+- Создание конфигурации с ограничением сетевого трафика (5 GB, 10 GB, 30 GB, 100 GB, без ограничений)
+- Получение информации об IP-адресе клиента (берется из Endpoint, используется API ресурса [ip-api.com](http://ip-api.com))
+- Создание ключа в формате `vpn://` при генерации нового клиента (так же, при получении конфигурации клиента), для использования в [AmneziaVPN](https://github.com/amnezia-vpn/amnezia-client)
+- Создание резервной копии
+
+## Установка
+
+1. Установите [AmneziaVPN](https://github.com/amnezia-vpn/amnezia-client) (без данного шага бот РАБОТАТЬ НЕ БУДЕТ).
+2. Пройдите первоначальную [инициализацию](https://docs.amnezia.org/ru/documentation/instructions/install-vpn-on-server/), выбрав протокол AmneziaWG, в клиенте [AmneziaVPN](https://github.com/amnezia-vpn/amnezia-client).
+
+3. Создайте бота в Telegram:
+
+- Откройте Telegram и найдите бота [BotFather](https://t.me/BotFather).
+- Начните диалог, отправив команду `/start`.
+- Введите команду `/newbot`, чтобы создать нового бота.
+- Следуйте инструкциям BotFather, чтобы:
+    - Придумать имя для вашего бота (например, `WireGuardManagerBot`).
+    - Придумать уникальное имя пользователя для бота (например, `WireGuardManagerBot_bot`). Оно должно оканчиваться на `_bot`.
+- После создания бота BotFather отправит вам токен для доступа к API. Его запросит бот во время первоначальной инициализации.
+
+4. Получите ваш Telegram ID с помощью [Get My ID](https://t.me/getmyid_bot), просто написав боту. 
+
+5. Загрузите и запустите скрипт `install.sh`, с помощью которого будет автоматически установлен бот, со всеми зависимостями, в том числе, в качестве системной службы (автозапуск):
+
+    ```bash
+    curl -O https://raw.githubusercontent.com/JB-SelfCompany/awg-docker-bot/main/install.sh && chmod +x install.sh && ./install.sh
+    ```
+
+## Запуск
+
+1. Добавьте бота в Telegram и отправьте команду `/start` или `/help` для начала работы.
+
+## Заметки
+
+Для обновления бота, необходимо запустить скрипт `install.sh`. В меню, необходимо выбрать пункт `Проверить обновления`.
+
+При создании резервной копии, в архив добавляется директория connections (создается и содержит в себе логи подключений клиентов), conf, png, и сам конфигурационный файл. 
+
+## Поддержка
+
+Поддержать разработчика можете следующими способами:
+- [Boosty](https://boosty.to/jb-selfcompany/donate)
+- LTC `ltc1qsa49jtpxau9f28fej7vpzj99lstx44792k4ack`
+- XMR `43ojbNWXSNCWjXAk1RbTvidACZKrWSpV7hXRosn9UQJhWEHHkzCB4g8Hh5sHhSzU7gBpwWkMFhgwuPLLuox6GqEQN7CLgHp`
+- BTC `bc1qt75kx0lwsw2npfh06kfq37gf97eper00sxp3tf` 
+
+Если у вас возникли вопросы или проблемы с установкой и использованием бота, создайте [issue](https://github.com/JB-SelfCompany/awg-docker-bot/issues) в этом репозитории или обратитесь к разработчику.
+
+- [Matrix](https://matrix.to/#/@jack_benq:shd.company)