diff --git a/README.md b/README.md index cf40d19..9122131 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # voice_logger -Бот, который логгирует голосовые каналы в дискорде. +Бот, который логирует голосовые каналы в дискорде. ## Установка зависимостей: ```bash python3 -m venv venv @@ -13,11 +13,23 @@ touch .env ``` Заполнить следующие переменные любым текстовым редактором: * token = "API токен дискорд бота" - +* cname = "Название текстового канала, в котором будет работать бот" +* role = "Название роли, у которой будет доступ к командам бота" --- -Запустить бота командой: +Запустить бота в фоне командой: ```bash -nohup python3 main.py & +nohup python3 ds_bot.py & +``` +Запустить бота не в фоне командой: +```bash +python3 ds_bot.py +``` +## Команды бота +```md +!start - Команда для начала логирования голосовых каналов. +!clear - Команда для очистки базы данных голосовой истории. +!send - Команда для отправки файла логов о подключениях и отключениях пользователей во всех голосовых каналах за день. +!log - Команда для вывода логов о подключениях и отключениях пользователей во всех голосовых каналах за день. +!status - Команда для получения статуса логирования голосовых каналов. +!stop - Команда для остановки логирования голосовых каналов. ``` -## Основная команда ботов -* !log *{название голосового канала}* - получение онлайна