]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/commitdiff
README update
authorMatthias H <apoc@sixserv.org>
Mon, 24 Feb 2014 05:37:36 +0000 (06:37 +0100)
committerMatthias H <apoc@sixserv.org>
Mon, 24 Feb 2014 05:37:36 +0000 (06:37 +0100)
README.md [new file with mode: 0644]
README.rdoc [deleted file]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..d4e1cac
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+= 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.
+
+== Fork Changelog
+
+- Drops ruby 1.8 support, ruby >= 1.9.3 is required.
+- Ruby 2.1.0 is supported.
+- Removes a lot of broken/outdated plugins.
+- Removes the DRb remote interface due to its abysmal security.
+- Introduces a web service.
+- Registry is now supporting DBM (that requires no external dependencies).
+
+== Known Problems
+
+Ruby 2.0.0 (at least <=p353) is causing a segmentation fault crash that
+only occurs after a few hours. https://bugs.ruby-lang.org/issues/9168
+
+DBM (if using Barkeley DB) is requiring manual repairs to work after
+a crash.
+
diff --git a/README.rdoc b/README.rdoc
deleted file mode 100644 (file)
index cd9a982..0000000
+++ /dev/null
@@ -1,45 +0,0 @@
-= 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, russian and finnish definitions so far - more translations welcome
-* Powerful plugin architecture, comes with plugins for:
-  - RSS feed updates
-  - IMDb queries
-  - Translator with multitude of services, it's easy as <code>!translate Ein Automobil</code>
-  - Last.fm
-  - Google searching
-  - URL information
-  - Seen +nick+?
-    * <code>rbot: seen tango? <rbot> tango_ was last seen 20 minutes and 7 seconds ago, joining #rbot</code>
-  - Reminders
-    * Example: <code>remind me about pizza in the oven in 15 minutes</code>
-  - Checking the weather
-  - Doing math
-  - GeoIP lookup
-  - Lots of games, including uno, hangman, azgame and roshambo
-  - Karma
-  - Per-channel quote storage, searching and retrieval
-  - Check the spelling of a word
-  - RPG dice rolling
-  - larting people
-  - Conversation stats — also, rbot log format is supported by {pisg}[http://pisg.sourceforge.net/]
-  - 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
-