From 932da0549a504e76442cf4abb57c921985f7e1f9 Mon Sep 17 00:00:00 2001
From: Ruslan Penkrat <penkrat@gmail.com>
Date: Sun, 5 Sep 2021 13:03:47 +0300
Subject: [PATCH] add readme

---
 stbf-demo/README.MD      | 56 ++++++++++++++++++++++++++++++++++++++
 stbf-templates/README.MD | 58 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 114 insertions(+)
 create mode 100644 stbf-demo/README.MD
 create mode 100644 stbf-templates/README.MD

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 <bot:token> -f <полный путь к конфигу>
+```
+
+### Файл конфигурации
+
+Если запустить без указания файла конфигурации бота, то будет использована следующая:
+
+```xml
+
+<flow>
+    <actions>
+        <action id="10001" name="start-action" command="/start">Start</action>
+        <action id="10002" name="help-action" command="/help">Help</action>
+    </actions>
+    <screens>
+        <screen id="20001" name="on-start-screen">
+            <text>This is demo bot</text>
+            <keyboard>
+                <row>
+                    <button actionRef="help-action">Action.name</button>
+                </row>
+            </keyboard>
+        </screen>
+        <screen id="20001" name="on-help-screen">
+            <text>This is demo help</text>
+            <keyboard>
+                <row>
+                    <button actionRef="help-action">Action.name</button>
+                </row>
+            </keyboard>
+        </screen>
+    </screens>
+    <commands>
+        <command actionRef="start-action" screenRef="on-start-screen" id="30001" name="startCommand"/>
+        <command actionRef="help-action" screenRef="on-help-screen" id="30002" name="helpCommand"/>
+    </commands>
+</flow>
+```
+
+Ее можно использовать как базу для разработки своей.
\ 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
+<flow>
+    <actions>  </actions>
+    <screens>  </screens>
+    <commands> </commands>
+</flow>
+```
+
+### Actions
+
+Action - Это действие пользователя бота, которое бот должен обработать  
+
+```xml
+<action id="10002" name="help-action" command="/help">Help</action>
+```
+
+`id`, `name` - идентификаторы узла (экшена)
+
+`command` - команда Telegram, должна начинаться со знака "/"
+
+содержимое тега - вводимый текст, используется как экранная кнопка
+
+
+
+### Screens
+
+Screen - то, что бот ответит пользователю, 
+обычно текст и набор кнопок с действиями.
+
+```xml
+        <screen id="20001" name="on-start-screen">
+            <text>This is demo bot</text>
+            <keyboard>
+                <row>
+                    <button actionRef="help-action">Action.name</button>
+                </row>
+            </keyboard>
+        </screen>
+```
+
+`text` - выводимый текст
+
+`keyboard` - описание клавиатуры
+
+### Commands
+
+Простая команда, при соверщении action будет выведен screen
+
+```xml
+<command actionRef="start-action" screenRef="on-start-screen" id="30001" name="startCommand"/>
+```
+
+`actionRef` - ссылка на action, может использоваться id или name
+`screenRef` - ссылка на screen, может использоваться id или name
\ No newline at end of file