-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
105 lines (89 loc) · 3.95 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<title>XMPP for Ruby</title>
<link rel="stylesheet" href="stylesheets/styles.css">
<link rel="stylesheet" href="stylesheets/pygment_trac.css">
<script src="javascripts/scale.fix.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
</head>
<body>
<div class="wrapper">
<header>
<h1>XMPP for Ruby</h1>
<p>XMPP4R is an XMPP/Jabber library for Ruby. </p>
<p class="view"><a href="https://github.com/xmpp4r/xmpp4r">View the Project on GitHub <small>xmpp4r</small></a></p>
<ul>
<li class="single"><a href="https://github.com/xmpp4r/xmpp4r">View On <strong>GitHub</strong></a></li>
</ul>
</header>
<section>
<h3>
<a name="welcome-to-github-pages" class="anchor" href="#welcome-to-github-pages"><span class="octicon octicon-link"></span></a>Introduction</h3>
<p>XMPP4R is an <a href="http://xmpp.org">XMPP</a>/<a href="http://jabber.org">Jabber</a> library for Ruby. Its goal is to provide a complete framework to develop Jabber-related applications or scripts in Ruby.</p>
<h3>Feature</h3>
<ul>
<li>Fully object-oriented</li>
<li>Aims at being XMPP compliant</li>
<li>Threaded, events-based</li>
<li>Well unit-tested and documented code</li>
<li>Uses well-known and well-tested software like REXML, instead of reinventing the wheel</li>
<li>Very easy to extend</li>
<li>Released under <a href="http://www.ruby-lang.org/en/LICENSE.txt">Ruby</a>'s license, which is compatible with the <a href="http://www.gnu.org/copyleft/gpl.html">GNU GPL</a> via an explicit dual-licensing clause.</li>
</ul>
<h3>Current State</h3>
<ul>
<li>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.</li>
<li>Haven't been updated in a while</li>
</ul>
<h3>Install xmpp4r</h3>
<pre>
<code>
$ gem install xmpp4r
</code>
</pre>
<h3>Usage</h3>
<h5> Write the following code in your project Gemfile</h5>
<pre>
<code>
gem 'xmpp4r'
</code>
</pre>
<h3>
<a name="authors-and-contributors" class="anchor" href="#authors-and-contributors"><span class="octicon octicon-link"></span></a>Authors and Contributors</h3>
<p>You can find the list of contributors <a href="https://github.com/xmpp4r/xmpp4r/graphs/contributors"> here</a></p>
<h3>
<a name="support-or-contact" class="anchor" href="#support-or-contact"><span class="octicon octicon-link"></span></a>Want to contribute to the code?</h3>
<p> You are awesome, its people like you who makes Open Source products valuable.</p>
<p> The steps to follow are </p>
<ol>
<li>Fork the project</li>
<li>Create your feature branch</li>
<li>Commit your changes</li>
<li>Push to the branch</li>
<li>Create a pull request</li>
</ol>
<p> You can find a list of <a href="https://github.com/xmpp4r/xmpp4r/issues"> known issues</a> or porpose a new feature <a href="https://github.com/xmpp4r/xmpp4r/issues/new"> here</a> </p>
</section>
</div>
<footer>
<p>Hosted on GitHub Pages — Theme by <a href="https://github.com/orderedlist">orderedlist</a></p>
</footer>
<!--[if !IE]><script>fixScale(document);</script><![endif]-->
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
try {
var pageTracker = _gat._getTracker("UA-44428902-1");
pageTracker._trackPageview();
} catch(err) {}
</script>
</body>
</html>