heipei-xmpp4r

= XMPP4R

== Contributors

Lucas Nussbaum [e-mail] Stephan Maka [e-mail] Kirill A. Shutemov [e-mail] Yuki Mitsui Peter Schrammel Olli Vojtech Vobr Andreas Wiese Chris Zelenak Sam Ruby Glenn Rempe [e-mail]

== Project Info

You can find info about the xmpp4r project and how to contribute at the project home page:

http://home.gna.org/xmpp4r/

If you need to ask questions, feel free to ask them on the [e-mail] mailing list. When reporting problems, please include a protocol dump which can be enabled with:

Jabber::debug = true

== Source Code

The source for xmpp4r is managed in a Git repository and can currently be found in our GitHub.com project page:

http://github.com/ln/xmpp4r/tree/master

== Installation

=== Install over the network

You can install current releases of the xmpp4r library from a release copy using RubyGems:

sudo gem install xmpp4r

If you want to install a gem snapshot built from the latest source code found on the master branch of our Git repository you can install using:

sudo gem install ln-xmpp4r -s http://gems.github.com

=== Install from local sources

If you have a local copy of the source repository or a tarball you can install xmpp4r using Rake/RubyGems. First you'll need to get a local copy.

Download using the Git SCM:

git clone git://github.com/ln/xmpp4r.git

OR download a .tar.gz archive from:

http://github.com/ln/xmpp4r/tarball/master

Now that you have the code, install using Rake:

Show all available rake tasks

cd xmpp4r/ rake -T

Package up the gem file and install it

rake install

== License

XMPP4R is released under the Ruby license (see the LICENSE file), which is compatible with the GNU GPL (see the COPYING file) via an explicit dual-licensing clause.