diff --git a/stbf-demo/README.MD b/stbf-demo/README.MD new file mode 100644 index 0000000..163d66b --- /dev/null +++ b/stbf-demo/README.MD @@ -0,0 +1,56 @@ +## Демо приложение + +Позволяет запустить простого бота, который будет отвечать на заранее определенные команды, +без программирования логики. + +### Запуск + +Собрать fat-jar + +```shell +mvn package +``` + +Запустить + +```shell +java -jar stbf-demo.jar -t -f <полный путь к конфигу> +``` + +### Файл конфигурации + +Если запустить без указания файла конфигурации бота, то будет использована следующая: + +```xml + + + + Start + Help + + + + This is demo bot + + + + + + + + This is demo help + + + + + + + + + + + + +``` + +Ее можно использовать как базу для разработки своей. \ No newline at end of file diff --git a/stbf-templates/README.MD b/stbf-templates/README.MD new file mode 100644 index 0000000..df00633 --- /dev/null +++ b/stbf-templates/README.MD @@ -0,0 +1,58 @@ +## Поддержка шаблонов и конфигурации + +### Основные секции + +```xml + + + + + +``` + +### Actions + +Action - Это действие пользователя бота, которое бот должен обработать + +```xml +Help +``` + +`id`, `name` - идентификаторы узла (экшена) + +`command` - команда Telegram, должна начинаться со знака "/" + +содержимое тега - вводимый текст, используется как экранная кнопка + + + +### Screens + +Screen - то, что бот ответит пользователю, +обычно текст и набор кнопок с действиями. + +```xml + + This is demo bot + + + + + + +``` + +`text` - выводимый текст + +`keyboard` - описание клавиатуры + +### Commands + +Простая команда, при соверщении action будет выведен screen + +```xml + +``` + +`actionRef` - ссылка на action, может использоваться id или name +`screenRef` - ссылка на screen, может использоваться id или name \ No newline at end of file