]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - README.md
fix: TCPSocked.gethostbyname is deprecated
[user/henk/code/ruby/rbot.git] / README.md
index 0fcd7f2fc2682cae5b1133e92a29cbabfec12a61..a43da56c4f4eccfad310e9f7a8117c457dd7af5d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,30 +1,18 @@
-# RBot - The Ruby IRC Bot
+# 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.
+[![Build Status](https://travis-ci.org/ruby-rbot/rbot.svg?branch=master)](https://travis-ci.org/ruby-rbot/rbot)
 
-## Install Guide
+rbot is designed around a flexible plugin system and is not only easy to
+extend, but it already includes many useful plugins. Some of the powerful
+features include:
 
-Information about installing the bot can be found here: [Install-Guide](https://github.com/4poc/rbot/wiki/Install-Guide).
+* Runtime configuration via irc
+* Flexible authentication and permission system
+* Plugin architecture that makes writing new plugins a breeze
+* Integrated web service
+* Batteries included: plugins for rss, twitter, imdb, translations, weather, notifications, lots of games and many more (over 70 plugins included)
 
-Notes on the registry and migrating from an old bot can be found here: [Registry-Migration-Notes](https://github.com/4poc/rbot/wiki/Registry-Migration-Notes).
+## Documentation
 
-## Fork Changes
+For more information about rbot visit our [github wiki](https://github.com/ruby-rbot/rbot/wiki).
 
-- Ruby 2.1.1 is fully supported.
-- Drops ruby 1.8 support, ruby >= 1.9.3 is required.
-- Removes a lot of broken/outdated plugins.
-- Removes the DRb remote interface due to its abysmal security.
-- Introduces a [web service](https://github.com/4poc/rbot/wiki/Web-Service).
-- Registry is now supporting DBM (that requires no external dependencies).
-- [New standalone Backup/Restore Script](https://raw.github.com/4poc/rbot/fork/bin/rbotdb) for registry databases.
-- Registry folders have now different names based on the adapter used: `~/.rbot/registry_<FORMAT>`
-- Added a bundler `Gemfile` to make installing the dependecies easier.
-
-## Known Problems
-
-* Ruby 2.0.0 (at least <=p353) is causing a segmentation fault crash that
-only occurs after a few hours. This is [fixed](https://bugs.ruby-lang.org/issues/9168) in newer versions of ruby.
-
-* DBM (if using Barkeley DB, maybe other backends aswell) is requiring manual repairs to work after
-a crash.