xmpp.chapril.org-conversejs/README.rst

99 lines
2.8 KiB
ReStructuredText
Raw Normal View History

2012-10-23 21:01:24 +02:00
===========
2012-07-21 11:14:22 +02:00
converse.js
===========
Converse.js_ is a web based `XMPP/Jabber`_ instant messaging client.
2012-10-23 21:01:24 +02:00
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
your own, or a public one.
2013-03-01 09:55:54 +01:00
It is used by collective.xmpp.chat_, which is a Plone_ instant messaging add-on.
2012-10-23 21:01:24 +02:00
2012-10-23 21:55:58 +02:00
--------
Features
--------
2012-10-23 21:01:24 +02:00
It has the following features:
* Single-user chat
* Multi-user chat in chatrooms
* vCard support
* Service discovery
* Contact rosters
* Manually or automically subscribe to other contacts
* Accept or decline contact requests
* Roster item exchange
* Chat statuses (online, busy, away, offline)
* Custom status messages
* Typing notifications
2012-10-23 21:54:32 +02:00
* Third person messages (/me )
* Translated into multiple languages (af, de, es, it, pt_BR)
-----------
Screencasts
-----------
* `In a static HTML page`_. Here we chat to external XMPP accounts on Jabber.org and Gmail.
* `Integrated into a Plone site`_ via collective.xmpp.chat.
----
Demo
----
A live demo is available at `conversejs.org`_
-----
Tests
-----
We use behavior-driven tests written with jasmine.js_. They can run in your
browser (`see here`_) or in the command line via phantom.js_.
We use `Travis-CI`_ for continuous integration.
.. image:: https://api.travis-ci.org/jcbrand/converse.js.png?branch=master
-------------
Documentation
-------------
The developer/integrator documentation can be found at `<http://conversejs.org/docs/html>`_.
------------
Dependencies
------------
2012-10-23 21:50:12 +02:00
It depends on quite a few third party libraries, including:
2012-10-23 22:38:56 +02:00
* jquery_
* strophe.js_
* backbone.js_
2012-10-23 21:01:24 +02:00
-------
Licence
-------
2012-10-23 21:54:32 +02:00
``Converse.js`` is released under both the MIT_ and GPL_ licenses.
2012-10-23 21:01:24 +02:00
.. _Converse.js: http://conversejs.org
2012-10-23 21:01:24 +02:00
.. _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
2012-10-23 21:01:24 +02:00
.. _MIT: http://opensource.org/licenses/mit-license.php
.. _GPL: http://opensource.org/licenses/gpl-license.php
2012-10-23 22:38:56 +02:00
.. _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
.. _`see here`: http://conversejs.org/tests.html
.. _phantom.js: http://phantomjs.org
.. _`Travis-CI`: https://travis-ci.org