diff --git a/src/karkas_blocks/karkas_blocks/standard/welcome/README.md b/src/karkas_blocks/karkas_blocks/standard/welcome/README.md index c4da55a..8a59c1d 100644 --- a/src/karkas_blocks/karkas_blocks/standard/welcome/README.md +++ b/src/karkas_blocks/karkas_blocks/standard/welcome/README.md @@ -1,10 +1,24 @@ -# Блоки Karkas +## Блок Welcome -Блоки Karkas — это набор блоков для платформы «Каркас», которые добавляют функциональность ботам. +Данный блок отвечает за верификацию новых участников чата, используя различные методы проверки. Он помогает предотвратить спам и автоматические атаки на чат, поддтверждая «человечность» новых пользователей. -## Типы блоков +## Функциональность -| Тип | Описание | -| :-------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| Стандартные (`standard`) | Блоки, содержащие основной функционал: управление пользователями, ролями и настройками | -| Дополнительные (`external`) | Блоки, созданные командой разработки платформы «Каркас». Предоставляют расширенные возможности: интеграция с нейросетями, внешними сервисами и API | +Блок поддерживает несколько методов верификации, которые случайным образом применяются к новым участникам чата: + +| Метод | Описание | +| :---------------------------: | ----------------------------------------------------------- | +| `IAmHumanButton` | Верификация с помощью кнопки | +| `IAmHumanInput` | Верификация с помощью ввода текста | +| `MathButtonsVerification` | Верификация решением математической задачи с помощью кнопок | +| `MathInputVerificationMethod` | Верификация решением математической задачи с помощью ввода | +| `QuestionButtonsVerification` | верификация ответом на вопрос с помощью кнопок | +| `QuestionInputVerification` | Верификация ответом на вопрос с помощью ввода | + +## Использование + +1. **Обработка новых участников**: когда новый участник присоединяется к чату, выбирается случайный метод верификации и создаётся задача проверки; +2. **Верификация**: + - **Верификация с помощью кнопок**: обработчик ожидает нажатия кнопки от пользователя и проверяет ответ; + - **Верификация с помощью ввода текста**: обработчик проверять введённый текст и проверяет ответ. +3. **Время на проверку**: если новый участник не проходит проверку в течение 30 секунд, его статус в чате меняется на "забанен".