From e7460c0a9edcfb6cd98eabba5b74c192da128499 Mon Sep 17 00:00:00 2001 From: Nikita Tyukalov Date: Fri, 21 Aug 2026 07:56:13 +0300 Subject: [PATCH] Updated README.md --- README.md | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c0c435d..b40d7de 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,23 @@ python main.py python main.py ``` -## Как работает этот бот +## Как работает бот + +Для каждой службы (канала уведомлений) создаётся своя собственная комната и в +такие комнаты добавляется бот. Затем вся работа с ботом производится при помощи +команд - текстовых сообщений, начинающихся с *восклицательного знака*. +Поддерживаются следующие команды: +- `!help` - получить справку +- `!info` - получить сведения о комнате +- `!tokens` - получить список токенов +- `!auth [SERVICE_NAME]` - создать новый токен (если указать имя сервиса, то + приложение, использующее токен, не сможет самостоятельно указывать имя + сервиса - всегда будет использовано имя, указанное вами) +- `!deauth ` - удалить токен +- `!name [SERVICE_NAME]` - указать (или удалить) имя сервиса для токена +- `!leave` - покинуть комнату + +## Как работает веб-сервер Этот бот запускает веб-сервер, используя `web_host` и `web_port` из файла конфигурации. @@ -58,14 +74,12 @@ python main.py - `POST //notify` - **Описание.** Используется, чтобы отправить уведомление в указанный канал. Вместо `` указывается код канала, получаемый при помощи команды - `!channel_code`, выполненной в комнате Matrix. + `!info`, выполненной в комнате Matrix. - **Тело запроса.** Тело запроса представляет собой `json` объект: ```json { - "service": "<название сервиса, передаётся только если разрешено>", - "subservice": "<название подсервиса>", - "text": "<текст уведомления>", - "urgent": false + "service": "<название сервиса; указывается, если токен это позволяет>", + "text": "<текст уведомления>" } ``` - **Тело ответа.** Тело ответа представляет собой `json` объект. В случае