= README for Butler2

== Indexing
* Author: Stefan Rusterholz <[email protected]>
* Version: 2.0.0
* Website: http://butler.rubyforge.org

== About
Butler is an easy to use IRC bot, extensible via plugins, with a full
authorization system, a remote login server and thorough localization support.

== Installing
=== Via RubyGems
gem install butler
sudo botcontrol setup

=== From SVN
svn checkout svn://rubyforge.org/var/svn/butler/trunk
cd trunk
sudo rake install_gem
sudo botcontrol setup
Notice, if checkout fails, try a few minutes later. Rubyforge drops anonymous svn connections on
higher load.

=== From Tarball
Download the latest release from http://rubyforge.org/frs/?group_id=1349&release_id=15267
Note that Tarball installation is currently discouraged as there's no automatic way to remove
the installed libs.
cd butler*
sudo rake install

=== Notes
The "botcontrol setup" creates the entries in the main config file that
is on most installations owned by root, which is why I put a "sudo" in
front of it.
Botcontrol setup is only required once per user.

== Synopsis
botcontrol create butler
botcontrol start butler
botcontrol stop butler
botcontrol list
botcontrol delete butler

== Links
* Butlers home: http://butler.rubyforge.org
* The project site: http://rubyforge.org/projects/butler