From 4df3901e73e990f4548ea6269bd1eeaf29485fb4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nikola=20Forr=C3=B3?= Date: Sat, 12 May 2018 11:34:51 +0200 Subject: [PATCH] Add README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3091309 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# Twitch chat bot + +The bot listens for responses to `!quote add`, `!quote edit` and `!quote remove` commands, and updates the quotes database accordingly +using [HTTP API](https://gitea.brno.mraveniste.cc/turbotraktor/ladylilia.com/src/branch/master/api/README.md). + +## Supported commands + +* `!lastquote` - requests the most recent quote +* `!findquote PATTERN` - searches for quotes matching `PATTERN` and in case multiple matches are found, requests one of them randomly + - `PATTERN` has to be at least 3 characters long and it can be enclosed in double quotes in case it contains spaces +* `!sync [SINCE]` - performs synchronization of the quotes database with Twitch VODs recorded since `SINCE` + - if `SINCE` is not specified, date of the most recent quote is used + - only master user is allowed to use this command