README

pyrl
====

pyrl is a simple bot that acts as a gateway between IRC and twitter.

After filling out the settings in the configuration file, pyrl will join the channel and server of your choice, periodically check your twitter timeline and direct messages, and then share these tweets and messages with the channel. You can interact with the bot via the commands detailed below.

It relies on py-scheduler (provided) and python-twitter: http://code.google.com/p/python-twitter/

The bot doesn't (yet) handle IRC very well. It will not recover from a kick or a disconnect. More robust IRC support is on the TODO list.


commands
========

pyrl provides the following commands:

* find out information about a user
    !who <name>

* get the last x tweets from a user:
    !fetch <name> [x]
    
* begin following someone:
    !follow <name>

* stop following someone:
    !unfollow <name>

* list all users that you are following:
    !following

* list all users that are following you:
    !followers

* post to twitter:
    !tweet <msg>

* send a direct message:
    !dm <friend> <msg>