Commit 8c80191a authored by JC Brand's avatar JC Brand

Update the readme with link to demo and info on tests

parent bacc288b
...@@ -4,10 +4,11 @@ converse.js ...@@ -4,10 +4,11 @@ converse.js
Converse.js_ is a web based `XMPP/Jabber`_ instant messaging client. 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. It is used by collective.xmpp.chat_, which is a Plone_ instant messaging add-on.
You will however need an XMPP server to connect to, either your own, or a public one.
-------- --------
Features Features
...@@ -15,15 +16,19 @@ Features ...@@ -15,15 +16,19 @@ Features
It has the following 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 * Accept or decline contact requests
* Chat status (online, busy, away, offline) * Roster item exchange
* Chat statuses (online, busy, away, offline)
* Custom status messages * Custom status messages
* Typing notifications * Typing notifications
* Third person messages (/me ) * Third person messages (/me )
* Multi-user chat in chatrooms * Translated into multiple languages (af, de, es, it, pt_BR)
* Chatroom Topics
* vCard support
----------- -----------
Screencasts Screencasts
...@@ -32,15 +37,32 @@ Screencasts ...@@ -32,15 +37,32 @@ Screencasts
* `In a static HTML page`_. Here we chat to external XMPP accounts on Jabber.org and Gmail. * `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. * `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 Dependencies
------------ ------------
It depends on quite a few third party libraries, including: It depends on quite a few third party libraries, including:
* jquery_
* strophe.js_ * strophe.js_
* backbone.js_ * backbone.js_
* require.js_
------- -------
Licence Licence
...@@ -61,3 +83,9 @@ Licence ...@@ -61,3 +83,9 @@ Licence
.. _Screencast2: http://opkode.com/media/blog/2013/04/02/converse.js-xmpp-instant-messaging-with-javascript .. _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 .. _`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 .. _`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
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment