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

Update the readme with link to demo and info on tests

Browse Source
This commit is contained in:
JC Brand 2013-07-28 23:39:11 +02:00
parent bacc288bea
commit 8c80191a96
1 changed files with 37 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.rst
View File

@ -4,10 +4,11 @@ converse.js
Converse.js_ is a web based `XMPP/Jabber`_ instant messaging client.
It is used by collective.xmpp.chat_, which is a Plone_ instant messaging add-on.
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.
The ultimate goal is to enable anyone to add chat functionality to their websites, independent of any backend.
You will however need an XMPP server to connect to, either your own, or a public one.
It is used by collective.xmpp.chat_, which is a Plone_ instant messaging add-on.
--------
Features
@ -15,15 +16,19 @@ Features
It has the following features:
* Manually or automically subscribe to other users.
* 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
* Chat status (online, busy, away, offline)
* Roster item exchange
* Chat statuses (online, busy, away, offline)
* Custom status messages
* Typing notifications
* Third person messages (/me )
* Multi-user chat in chatrooms
* Chatroom Topics
* vCard support
* Translated into multiple languages (af, de, es, it, pt_BR)
-----------
Screencasts
@ -32,15 +37,32 @@ 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
------------
Dependencies
------------
It depends on quite a few third party libraries, including:
* jquery_
* strophe.js_
* backbone.js_
* require.js_
-------
Licence
@ -61,3 +83,9 @@ Licence
.. _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://converse.js.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