From 2ebe5ffe668381ac274f997cec84c598d1ebcde0 Mon Sep 17 00:00:00 2001 From: Jonathan Bender Date: Tue, 30 Jul 2019 00:29:00 -0400 Subject: [PATCH 1/3] Update README.md Added a description of all available commands for use. --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0155060..07d49b3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,11 @@ # Bash-Bot -Using Discord to control a terminal +Uses the Discord.py API to run a Discord bot's instance, eventually intended to run Bash commands locally on a dedicated Linux device. + +------------------------------------ + +# Commands +By preceding a statement with `!`, the first word of a statement is considered to be a command and every other word an operand. +## !hello +Responds to the author with "Hello @author!" in the channel the command was sent through. +## !download +Downloads the first attached file sent by the user. From 406403d55b1aa63a12e2f3b6c1c8bc374e616b86 Mon Sep 17 00:00:00 2001 From: Jonathan Bender Date: Tue, 30 Jul 2019 00:31:44 -0400 Subject: [PATCH 2/3] Update README.md Didn't even think to just leave the command symbol in only one place for maintainability reasons. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 07d49b3..38e2bba 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Uses the Discord.py API to run a Discord bot's instance, eventually intended to # Commands By preceding a statement with `!`, the first word of a statement is considered to be a command and every other word an operand. -## !hello +## hello Responds to the author with "Hello @author!" in the channel the command was sent through. -## !download +## download Downloads the first attached file sent by the user. From 71ab8bd5191c43c764fd946d27f64cc8da584d5f Mon Sep 17 00:00:00 2001 From: Jonathan Bender Date: Tue, 30 Jul 2019 00:34:19 -0400 Subject: [PATCH 3/3] Update README.md Explained the basics of mentions for any examples given with commands. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 38e2bba..e5a9ce4 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Uses the Discord.py API to run a Discord bot's instance, eventually intended to ------------------------------------ # Commands -By preceding a statement with `!`, the first word of a statement is considered to be a command and every other word an operand. +By preceding a statement with `!`, the first word of a statement is considered to be a command and every other word an operand. Any time @user is incurred, it is with reference to a particular user and will send any user who has not muted the channel or bot in question a notification. These instances exist for the sake of example and are not to be taken verbatim. ## hello Responds to the author with "Hello @author!" in the channel the command was sent through. ## download