summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMatthias H <apoc@sixserv.org>2014-02-24 06:37:36 +0100
committerMatthias H <apoc@sixserv.org>2014-02-24 06:37:36 +0100
commit78c79eae617df21a6188c6b47cd9dcf56e54904e (patch)
treebc90b4de0bec5103e9109ea0ea4f19c772f6b520 /README.md
parentf0d77a23a406fc1a04d82c356799bb1df93159ec (diff)
README update
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..d4e1cacf
--- /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.
+