From 33bdfde706205af982e0e14c139c83330aa9b5ab Mon Sep 17 00:00:00 2001 From: upagge Date: Sun, 3 May 2020 02:50:36 +0300 Subject: [PATCH] readme --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 47926e1..b4da95f 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Абстрактная реализация, которая позволяет создавать ботов. Боты позволяют автоматизировать взаимодействие с пользователем. Боты позволяют автоматизировать общение с клиентами, отвечая по запрограммированию сценарию. -# Dependency +## Dependency maven: ``` @@ -13,7 +13,7 @@ maven: ``` -### Основные понятия +## Основные понятия **Unit** - некая единица сценария, по которому проходит пользователь, отправляя свои сообщения. Каждый юнит хранит в себе ключевые слова или регулярное выражение, ссылки на следующие Unit-ы, а так же значение @@ -24,7 +24,7 @@ Unit можно найти в [этом репозитории](https://github.c **Сценарий** - это связанные между собой юниты. -### Принцип работы +## Принцип работы Для понимания рассмотрим небольшой пример по схеме изображенной ниже. Так же небольшие примеры обработки есть в тестах. @@ -45,7 +45,7 @@ Unit можно найти в [этом репозитории](https://github.c приоритеты равны, то случайный Unit. В нашем примере, на первое сообщение, пользователь получил Unit1, поэтому следующее сообщение пользователя будет ассоциироваться с множеством: Unit2, Unit3 и Unit4. -### Програмная реализация +## Програмная реализация Данная библиотека предназначена только на определение того, какой Unit отдавать. Для использования библиотеки необходимо в первую очередь создать наследника класса `Unit` (самый простой вариант лежит в тестах). Следом создается объект класса @@ -57,7 +57,7 @@ Unit, который был отправлен пользователю. Далее у объекта `AutoResponder` вызывается метод `answer`, который возвращает следующий для пользователя Unit. -### Программные особенности +## Программные особенности 1. Существует возможность задать юнит, который будет возвращаться при отсутствии юнита, удовлетворяющего сообщению пользователя (без ключевых слов, и т.п.). Для этого у объекта `AutoResponder` вызывается метод `setDefaultUnit`.