From 4d7b94527195dbf3a73c5e6a4753ecfd23934e26 Mon Sep 17 00:00:00 2001 From: Tearzz Date: Thu, 19 Apr 2018 16:16:25 +0200 Subject: [PATCH] Updated README.md More descriptive, added images. --- README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b69f03a..9373608 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A simple chatbot for Twitch written in Ruby. Used for handling commands and prev ---- ## Preview -![alt text](https://imgur.com/a/caDmuaG "Preview of the chat bot") +![alt text](https://i.imgur.com/QOuqtfS.png "Preview of the chat bot") ---- @@ -20,16 +20,24 @@ But as you can see in the preview image it's also able to handle custom commands **Adding Commands:** 1. Open **"CommandsHandler.rb"** and scroll down to the `commands` array and add your own. -2. Go to folder **"Responses"** and add the command as a text file in all lowercase. _Examples have been included_ - -_If you are adding admin commands add a custom response next to it. There you'll be able to add commands that gives data to the socket instead of a chat message as a response. Example: +2. Go to folder **"Responses"** and add the command as a text file in all lowercase. _Examples have been included_ + +If you are adding admin commands add a custom response next to it. There you'll be able to add commands that gives data to the socket instead of a chat message as a response. Example: `admin_commands = { "disconnect" => "PART ##{CHANNEL}" }` -When the command `"!disconnect"` has been typed in chat ("!" is the default prefix but can be changed) by the channel owner it will send a request to disconnect from the current Twitch channel._ -**Extras:** -The response files in the Responses folder have 3 arguments available (You can add your own) -![alt text](https://imgur.com/gallery/6gOrmQY "Preview of command arguments") +When the command `"!disconnect"` has been typed in chat by the channel owner it will send a request to disconnect from the current Twitch channel._ + +![alt text](https://i.imgur.com/iYtSvaG.png "Prefix, commands and admin commands") + +---- + +## Extras: +_**The response files in the Responses folder have 3 arguments available**_ (You can add your own) -In the template the arguments USER, CHANNEL, COMMANDS are available. _(COMMANDS shows all available commands)_ +![alt text](https://i.imgur.com/Pb6JPz8.png "Preview of command arguments") + +In the template the arguments USER, CHANNEL, COMMANDS are available. _(COMMANDS shows all available commands)_ + +![alt text](https://i.imgur.com/vX2XFof.png "Here you can add your replacements")