commit: 5651fceed0676478a8890bd7d076c0fe2f746d17
parent: b7354b816eb802a386db174e3948cf35b61de740
Author: Haelwenn Monnier <lanodan.delta@free.fr>
Date: Mon, 30 Jun 2014 13:13:32 +0200
Update README.md
markdown syntax ♥
Diffstat:
| M | IRCBot/README.md | 95 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------- |
1 file changed, 75 insertions(+), 20 deletions(-)
diff --git a/IRCBot/README.md b/IRCBot/README.md
@@ -1,20 +1,75 @@
-A simple IRCBot for only one channel.
-It works on all IRC servers.
-
-#Commands
-syntax: [optional] <required>
-``!hi [text]`` Welcome users. (the bot doesn't welcome users automatically yet)
-``!say <text>`` say some text
-``!action <text>`` do some actions(same as the /me)
-``!source`` Give a link to the sourcode
-``!stop in the name of sey`` Stop the bot with a nice reference to SYRSA
-
-#Configuration
-nick nickname
-passwd= password
-server= Server IP/address (e.g ``server=irc.freenode.net``)
-port= Server Port (note: Most of the time it's ``port=6667``)
-channel= Channel, you can put only one channel for now
-quitMessage= The message when the bot quits the server
-welcomeMessage= The message when the bot arrives in the channel
-source= The sourcecode of the bot (e.g ``source=My sourcecode is under CC-BY-SA and available at the following address: https://github.com/lanodan/scripts/tree/master/IRCBot``
+#IRCBot
+
+A simple IRCBot for only one channel. Works on all IRC servers.
+
+Commands
+--------
+syntax ``[optional] <required>``
+
+``
+!hi [text]
+``
+Welcome users. (the bot doesn't welcome users on join yet)
+
+``
+!say <text>
+``
+say something
+
+``
+!action <text>
+``
+do some actions(same as the /me)
+
+``
+!source
+``
+Give a link to the sourcode
+
+``
+!stop in the name of sey
+``
+Stop the bot with a nice reference to SYRSA
+
+Configuration
+-------------
+``
+nick
+``
+nickname
+
+``
+passwd=
+``
+password. if you don't have any password do as you want.
+
+``
+server=
+``
+Server address (e.g ``server=irc.freenode.net``)
+
+``
+port=
+``
+Server Port (note: Most of the time it's ``port=6667``)
+
+``
+channel=
+``
+Channel, put one channel where you want to the bot to run.
+
+``
+quitMessage=
+``
+The message when the bot quits the server
+
+``
+welcomeMessage=
+``
+The message when the bot arrives in the channel
+
+``
+source=
+``
+The sourcecode of the bot (e.g ``source=My sourcecode is under CC-BY-SA and available at the following address:
+https://github.com/lanodan/scripts/tree/master/IRCBot``)
