Floppy / jabberstatus

JabberStatus
------------

A Ruby app which implements an XMPP -> Status gateway for Facebook and Twitter.


REQUIREMENTS
------------

ruby >= 1.8
rubygems
xmpp4r >= 0.3.2
facebooker >= subversion rev 217 (0.9.5 doesn't work)
twitter >= 0.3.7
log4r >= 1.0.5
daemons >= 1.0.10
json >= 1.1.2

INSTALLATION
------------

If you want to *use* the service, you don't need to install anything. Just add
facebook@jabber.org or twitterstatus@jabber.org to your Jabber contact list 
and follow the instructions.

If you don't trust me with your information (sensible), and want to run your own
version of the gateway:

1) Download from http://floppy.github.com/jabberstatus

2) Extract to a directory on your machine (tar xzvf jabberstatus.*.tar.gz)

3) Copy config/config_example.yml to config/config.yml.

4) Edit config/config.yml to add the jabber account login details you 
   want to use for the gateway.

5) For facebook, create a desktop app on facebook, and enter your API and secret 
   key into config/config.yml. For Twitter, just make up a couple of secret keys
   and enter them in config/config.yml. Note that you can only run one at a time,
   so if you want to do both, you will need two instances running with different
   config files.

6) Run "ruby bin/jabberstatus_control.rb start" to start the service (you can
   also use the stop, restart and run commands).

7) Add the Jabber account in config.yml to your contact list, and enjoy updating
   your status through Jabber!


CONTACT
-------

Homepage: http://floppy.github.com/jabberstatus
Developer: james@floppy.org.uk

LICENSE
-------

Copyright (c) 2008 James Smith (www.floppy.org.uk)

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.

http://www.opensource.org/licenses/mit-license.php