@@ -50,9 +50,9 @@ framework to develop Jabber-related applications or scripts in Ruby.</p> <h3>Current status</h3> -<p>You can basically do everything you want with XMPP4R. It fully supports XMPP, and also a wide range of extensions (JEPs). Also, it's very easy to extend.</p> +<p>You can basically do everything you want with XMPP4R. It fully supports XMPP, and also a wide range of extensions (XEPs). Also, it's very easy to extend.</p> -<p>A lot of examples are shipped with XMPP4R (see <i>/usr/share/doc/xmpp4r/examples/</i> or <i>/usr/local/share/doc/xmpp4r/examples/</i>, depending on how you installed XMPP4R).</p> +<p>A lot of examples are shipped with XMPP4R (If you installed from a linux package see <code>/usr/share/doc/xmpp4r/examples/</code> or <code>/usr/local/share/doc/xmpp4r/examples/</code>, or take a look in the <code>data/doc</code> dir if you have a copy of the source code).</p> <a name="download"></a> <h2>Download and Installation</h2> @@ -63,18 +63,19 @@ framework to develop Jabber-related applications or scripts in Ruby.</p> <p>Releases are available here: <a href="http://download.gna.org/xmpp4r/">http://download.gna.org/xmpp4r/</a>. Untar the archive and run <code>./setup.rb</code></p> -<h3>Using Rubygems</h3> +<h3>Using RubyGems</h3> <p><code>gem install xmpp4r</code></p> <h3>Using a package for your distribution</h3> <p>There's a package available in Debian and Ubuntu. Just <code>apt-get install libxmpp4r-ruby</code>. With Gentoo, XMPP4R can be installed via <code>emerge dev-ruby/xmpp4r</code>.</p> -<h3>Using Rubygems to install from GitHub (development version)</h3> +<h3>Using RubyGems to install from GitHub (development version)</h3> +<p>You should be using RubyGems version 1.2.0+ to use this method</p> <p><code>gem sources -a http://gems.github.com</code> (you only need to do this once!)<br/> <code>gem install ln-xmpp4r</code></p> -<h3>Using GIT to install the development version</h3> -<p><code>git-clone git://github.com/ln/xmpp4r.git</code> (see <a href="http://github.com/ln/xmpp4r">GitHub</a>)</p> +<h3>Using Git to install the development version</h3> +<p><code>git clone git://github.com/ln/xmpp4r.git</code> (see <a href="http://github.com/ln/xmpp4r">GitHub</a>)</p> <a name="related"></a> @@ -115,25 +116,25 @@ a Ruby on Rails convenience framework like Action Mailer, only for instant messa <ul><li><a href="https://mail.gna.org/listinfo/xmpp4r-devel/">xmpp4r-devel Info Page</a> (to subscribe/unsubscribe, etc)</li> <li><a href="https://mail.gna.org/public/xmpp4r-devel/">xmpp4r-devel archives</a></li> </ul> -<p>Bug can be reported to the mailing or on the <a href="https://gna.org/projects/xmpp4r/">GNA project page</a>.</p> +<p>Bugs can be reported to the mailing list or on the <a href="https://gna.org/projects/xmpp4r/">GNA project page</a>.</p> <p>When reporting bugs, please provide as much information as possible:</p> <ul> <li>Contact information</li> - <li>XMPP4R version or GIT revision</li> + <li>XMPP4R version or Git SHA1 commit</li> <li>Use <em>Jabber::debug = true</em> but remove any sensitive information</li> <li>Describe your environment (Ruby version, OS, server software)</li> <li>Cool hackers send test cases</li> </ul> -<p>The main development branch is hosted on <a href="http://github.com/ln/xmpp4r/tree/master">Github</a></b>. We encourage contributors to get familiarized with git, as git makes it very easy to get patches into the project, not just for the maintainer but also for the contributor himself. A few typical questions are answered on the <a href="http://github.com/ln/xmpp4r/wikis/developer-faq">GitHub FAQ Page</a>. Feel free to make a GitHub 'fork' of the project and send us pull requests or patches to the xmpp4r-devel mailing list.</p> +<p>The main development branch is hosted on <a href="http://github.com/ln/xmpp4r/tree/master">Github</a></b>. We encourage contributors to get familiarized with Git, as Git makes it very easy to get patches into the project, not just for the maintainer but also for the contributor himself. A few typical questions are answered on the <a href="http://github.com/ln/xmpp4r/wikis/developer-faq">GitHub FAQ Page</a>. Feel free to make a GitHub 'fork' of the project and send us pull requests or patches to the xmpp4r-devel mailing list.</p> <p>The SVN repository isn't updated anymore, but is still accessible at <code>svn co svn://svn.gna.org/svn/xmpp4r/trunk/xmpp4r</code> for historical reasons.</p> -<p>The RDOC source code documentation is <a href="rdoc/">browseable here</a>. It might not be update to date (but we try hard to make it be). You can generate your own using <code>rake rdoc</code></p> +<p>The RDOC source code documentation is <a href="rdoc/">browseable here</a>. It might not be completely up-to-date (but we try hard to make it be). If you have the source code you can generate your own using docs using <code>rake rdoc</code></p> -<h3>Articles about developping with XMPP4R</h3> +<h3>Articles about developing with XMPP4R</h3> -<p><b>Famundo Dev Blog</b> has a series of introductionary articles about XMPP4R:</p> +<p><b>Famundo Dev Blog</b> has a series of introductory articles about XMPP4R:</p> <ul> <li><a href="http://devblog.famundo.com/articles/2006/10/10/ruby-and-xmpp-jabber-a-multi-posts-series">Ruby and XMPP/Jabber - a Multi Posts Series, Part 1</a></li> <li><a href="http://devblog.famundo.com/articles/2006/10/14/ruby-and-xmpp-jabber-part-2-logging-in-and-sending-simple-messages">Ruby and XMPP/Jabber Part 2: Logging in and sending simple messages</a></li> @@ -148,7 +149,7 @@ a Ruby on Rails convenience framework like Action Mailer, only for instant messa Integration With XMPP4r : Part 2</a></li> </ul> -<p>A german tutorial is available at the BSD-Crew Wiki: <a href="http://wiki.bsd-crew.de/index.php/Jabberbots_mit_XMPP4R">Jabberbots mit XMPP4R</a></p> +<p>A German tutorial is available at the BSD-Crew Wiki: <a href="http://wiki.bsd-crew.de/index.php/Jabberbots_mit_XMPP4R">Jabberbots mit XMPP4R</a></p> </div> website/index.html 8f64abec91b12736a79e93a4648145f2e7a24b03 Glenn Rempe glenn@rempe.us http://github.com/ln/xmpp4r/commit/8e3f836c31a7f6d0b66cd1ffc50efb7633d7e03b 8e3f836c31a7f6d0b66cd1ffc50efb7633d7e03b 2008-06-24T12:39:04-07:00 2008-06-24T12:21:52-07:00 Website updates. - Changed reference to JEP to XEP - Updated locations for code samples to be more inclusive - RubyGems (not rubygems or Rubygems) is the correct spelling - Git (not GIT) is the correct spelling - git-clone is the deprecated form. It is 'git clone'. - RubyGem installation of release version should assume RubyForge simple install not Gna.org. - Miscellaneous spelling errors - Git commits have SHA1 commit ID's not revisions. - Germans like their country to be capitalized. :-) da1c8e2b2a7fd4544ffd21f3d574d497f043654a Glenn Rempe glenn@rempe.us