Chapril/xmpp.chapril.org-conversejs
Chapril/xmpp.chapril.org-conversejs
25
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

Clean up readme

Browse Source
This commit is contained in:
JC Brand 2014-03-18 03:12:25 +02:00
parent 5e853d5d30
commit d5a41e1739
2 changed files with 18 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.rst
View File

@ -5,7 +5,8 @@ converse.js
.. figure:: https://api.travis-ci.org/jcbrand/converse.js.png?branch=master
:alt: Build Status
Converse.js_ is a web based `XMPP/Jabber`_ instant messaging client.
`Converse.js <https://conversejs.org>`_ is a web based `XMPP/Jabber <http://xmpp.org>`_
instant messaging client.
It enables you to add chat functionality to your website, independent of any
specific backend. You will however need an XMPP server to connect to, either
@ -56,37 +57,27 @@ Integration into other frameworks
Demo
----
A live demo is available at `conversejs.org`_
A live demo is available at `<https://conversejs.org>`_
-----
Tests
-----
We use behavior-driven tests written with jasmine.js_. They can run in your
browser or in the command line via phantom.js_.
We use behavior-driven tests written with `jasmine.js <http://pivotal.github.io/jasmine>`_.
They can run in your browser or in the command line via `phantom.js <http://phantomjs.org>`_.
-------------
Documentation
-------------
The developer/integrator documentation can be found at `<http://conversejs.org/docs/html>`_.
------------
Dependencies
------------
It depends on quite a few third party libraries, including:
* jquery_
* strophe.js_
* backbone.js_
The developer/integrator documentation can be found at `<https://conversejs.org/docs/html>`_.
-------
Licence
-------
``Converse.js`` is released under both the MIT_ and GPL_ licenses.
``Converse.js`` is released under both the `MIT <http://opensource.org/licenses/mit-license.php>`_
and `GPL <http://opensource.org/licenses/gpl-license.php>`_ licenses.
-------
Support
@ -95,28 +86,11 @@ Support
For support queries and discussions, please join the mailing list: conversejs@librelist.com
Issues can be logged on the `Github issue tracker <https://github.com/jcbrand/converse.js/issues>`_.
---------------------------------
Donations or tips are appreciated
---------------------------------
----------------------------------
Donations and tips are appreciated
----------------------------------
* Bitcoin: 16FsPqE9DhFTryxrUenpsGX4LJ1TPu8GqS
* Litecoin: LLvLH6qJch7HAamLguHkwobCrxmHLhiwZw
.. _Converse.js: http://conversejs.org
.. _strophe.js: http://strophe.im/strophejs
.. _backbone.js: http:/backbonejs.org
.. _require.js: http:/requirejs.org
.. _collective.xmpp.chat: http://github.com/collective/collective.xmpp.chat
.. _Plone: http://plone.org
.. _`XMPP/Jabber`: http://xmpp.org
.. _MIT: http://opensource.org/licenses/mit-license.php
.. _GPL: http://opensource.org/licenses/gpl-license.php
.. _here: http://opkode.com/media/blog/instant-messaging-for-plone-with-javascript-and-xmpp
.. _Screencast2: http://opkode.com/media/blog/2013/04/02/converse.js-xmpp-instant-messaging-with-javascript
.. _`Integrated into a Plone site`: http://opkode.com/media/blog/instant-messaging-for-plone-with-javascript-and-xmpp
.. _`In a static HTML page`: http://opkode.com/media/blog/2013/04/02/converse.js-xmpp-instant-messaging-with-javascript
.. _`conversejs.org`: http://conversejs.org
.. _jquery: http://jquery.com
.. _jasmine.js: http://pivotal.github.io/jasmine
.. _phantom.js: http://phantomjs.org
.. _`Travis-CI`: https://travis-ci.org

11
docs/CHANGES.rst
View File

@ -4,7 +4,8 @@ Changelog
0.7.4 (2014-03-05)
------------------
.. note:: This release contains an important security fix.
.. note::
This release contains an important security fix.
Thanks to Renaud Dubourguais from `Synacktiv http://synacktiv.com`_ for reporting the vulnerability.
* #125 Bugfix: crypto dependencies loaded in wrong order [jcbrand]
@ -25,7 +26,8 @@ Changelog
0.7.2 (2013-12-18)
------------------
.. note:: This release contains an important security fix.
.. note::
This release contains an important security fix.
Thanks to hejsan for reporting the vulnerability.
* #48 Add event emitter support and emit events. [jcbrand]
@ -114,8 +116,9 @@ Bugfixes:
0.6.3 (2013-09-12)
------------------
NB: This release contains an important security fix. Please don't use older
versions of the 0.6 branch.
.. note::
This release contains an important security fix. Please don't use older
versions of the 0.6 branch.
* French translations. [tdesvenain]
* Bugfix: Messages were stored against buddy JID and not own JID. [jcbrand]