summaryrefslogtreecommitdiff
path: root/README.rdoc
diff options
context:
space:
mode:
authorRaine Virta <rane@kapsi.fi>2010-04-16 18:08:17 +0300
committerRaine Virta <rane@kapsi.fi>2010-04-16 22:58:24 +0300
commit55c7d10794d6d7cdceae3131b3a2917403655f2a (patch)
treeed2e641e44d002510b4b9cfc3707a8a31d53fa35 /README.rdoc
parent6ca0084780f82de5b4e06a2d242a9f9fd5bad63e (diff)
change README's extension to rdoc
We get cooler github readme.
Diffstat (limited to 'README.rdoc')
-rw-r--r--README.rdoc43
1 files changed, 43 insertions, 0 deletions
diff --git a/README.rdoc b/README.rdoc
new file mode 100644
index 00000000..7af09f6e
--- /dev/null
+++ b/README.rdoc
@@ -0,0 +1,43 @@
+= rbot - The Ruby IRC bot
+
+rbot is a ruby IRC bot. Think of him as a ruby bot framework with a highly
+modular design based around plugins.
+
+== rbot features
+
+* Runtime configuration via irc chat
+* User authentication and access levels for using different bot features
+* Built in infobot-style keywords.
+* Support for underlying fact database (infobot fact files), which can
+ be overridden or supplemented by runtime keyword controls
+* Multi-language support - comes with english, dutch, german, french, italian
+ japanese, chinese and russian definitions so far - more translations welcome
+* Powerful plugin architecture, comes with plugins for:
+ - DNS queries
+ - Babelfish translation
+ - Google searching
+ - Excuse generation
+ - Insult generation
+ - Karma
+ - Checking the weather
+ - Querying slashdot
+ - Doing Math
+ - Per-channel quote storage, searching and retrieval
+ - Reminders
+ - rot13 translation
+ - Check the spelling of a word
+ - Webserver Server: header examination
+ - RPG dice rolling
+ - larting people
+ - conversation stats
+ - more...
+
+Thanks are owed to the infobot developers - several of rbot's features are
+inspired by infobot and so are some of the default plugins. Thanks are also
+owed to RADKade1, as rbot's quote plugin is a direct reimplementation of his
+"quotesaq" - simply because it's a great quote interface.
+
+Mainly, rbot's fun to play with, although the plugin architecture can be used
+to write very useful modules
+
+