Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

For the readme file #10

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,37 @@
[[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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you should name "arg" something more helpful

e.g.: ?summon [query]

looks pretty good though

the argument as a search query.

?resummon [arg] Has the same behavior as summon but will return the next
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, lets put the commands in code blocks (ie wrap them in back ticks) and put a newline between the command and the description since processed markdown ignores the formatting we have here.

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.

?spoonerize [args] swaps corresponding vowels and consonants between
words.