From 388e05b1196d120187f0b9c2d9b5adb457fe0fb4 Mon Sep 17 00:00:00 2001 From: Andrew Spano Date: Fri, 19 Apr 2013 20:15:43 -0400 Subject: [PATCH 1/3] modified readme to include some commands and a description of which each command does. --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dbaac62..8f47b9c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ [[mccs-bot]] -======== + +This is the irc bot used by the Marist College Computer Society irc server +(mccs.stu.marist.edu). The bot has the ability to parse and execute several +unique commands. Commands are preceeded by a question mark and proceeded by a +space followed by any arguments. Commands can not be nested and are case +sensitive. + +The available commands are described bellow: + +?hello Displays a welcome message addressed to the calling user + +?summon [arg] Displays the hyperlink to the first google image result using + the argument as a search query. + +?resummon [arg] Has the same behavior as summon but will return the next + search result if called again with the same argument. + +?ligaf Displays the hyperlink to one of two possible + "Like I give a fuck" memes. + +?++ [arg] [optional arg] Adds a plus to the user specified in the first + argument unless the specified user is the calling user + in which case that user is penalized by losing a plus. + If provided with the optional argument, that argument + is displayed as the reason for having that plus awarded. + +?pluses [arg] [optional arg] alias for ?++, but also displays the reasons + that were given for awarding that user + with pluses. + +?plus_leaders Displays the current leaders with the 10 greatest amount of + pluses in order of the number of pluses each leader has. +======== \ No newline at end of file From cc88d08eae819214bacc4a817f508c47ee2607c0 Mon Sep 17 00:00:00 2001 From: Andrew Spano Date: Fri, 19 Apr 2013 20:21:29 -0400 Subject: [PATCH 2/3] added ======= for proper bolding --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8f47b9c..f899a75 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ space followed by any arguments. Commands can not be nested and are case sensitive. The available commands are described bellow: +======= ?hello Displays a welcome message addressed to the calling user @@ -30,5 +31,4 @@ The available commands are described bellow: with pluses. ?plus_leaders Displays the current leaders with the 10 greatest amount of - pluses in order of the number of pluses each leader has. -======== \ No newline at end of file + pluses in order of the number of pluses each leader has. \ No newline at end of file From 519f79b595c172f271f4cc5781013a6975ed0ab7 Mon Sep 17 00:00:00 2001 From: Andrew Spano Date: Fri, 19 Apr 2013 20:31:57 -0400 Subject: [PATCH 3/3] added all of the commands I could discover to the readme file --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f899a75..b4ded72 100644 --- a/README.md +++ b/README.md @@ -31,4 +31,7 @@ The available commands are described bellow: with pluses. ?plus_leaders Displays the current leaders with the 10 greatest amount of - pluses in order of the number of pluses each leader has. \ No newline at end of file + pluses in order of the number of pluses each leader has. + +?spoonerize [args] swaps corresponding vowels and consonants between + words. \ No newline at end of file