README

RTwittBot
    by Jesús GS <blaxter@gmail.com>
    http://github.com/blaxter/rtwittbot

== DESCRIPTION:

Personal twitter jabber bot. Until the IM service of twitter will be restored (since may is off...),
the goal of this project is substitute the funcionality of that function.

You can execute this bot with some jabber account and talk to him for posting to yout twitter 
account, and for every update in your timeline, you'll received an IM message from the bot.

== FEATURES/PROBLEMS:

* Things to do:
  * Export the configuration file to yaml in user directory
  * Make gem-installable
* Things could be fun to do:
  * Communicate with other microblogging systems (plurk, jaiku), that way you can interact with all of them with the same account (your jabber account), making the bot a wrapper of all your microblogging accounts
== SYNOPSIS:

  FIXME (code sample of usage)

== REQUIREMENTS:

* The following gems are required:
  * gem install twitter4r
  * gem install xmpp4r
  * gem install daemons
  * gem install idn

== INSTALL:

* For now:
  * $ git://github.com/blaxter/rtwittbot.git
  * cd rtwittbot.git && vim lib/rtwittbot/config.rb
     * Configure the constants according to your accounts and so on
  * Execute the daemon: $ bin/rtwittbotd start

== LICENSE:

(The MIT License)

Copyright (c) 2008 Jesús García Sáez <blaxter@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.