From d7bb13500d611040fe86c35124deeac4b7033f57 Mon Sep 17 00:00:00 2001 From: JC Brand Date: Tue, 23 Oct 2012 21:01:24 +0200 Subject: [PATCH] Updated readme --- README.md | 41 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5208b278f..5728b23d5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,43 @@ +=========== converse.js =========== -Web-based XMPP Instant Messaging client written in javascript \ No newline at end of file +``Converse.js`` implements an ``XMPP`` based instant messaging client in the browser. + +*Warning*: This library is still heavily under development! + +It has the following features: + +* Manually or automically subscribe to other users. +* With manual roster subscriptions, you can accept or decline contact requests. +* Chat statuses (online, busy, away, offline) +* Custom status message +* Typing notifications (i.e when the contact is typing) +* Third person messages (/me ) +* Multi-user chat in chatrooms +* Topics can be set for chatrooms +* Full name and profile picture support + +Converse.js is used by ``collective.xmpp.chat``, which is a ``Plone`` instant +messaging add-on. + +It depends on quite a few third party libraries, including ``strophe.js``, +``backbone.js`` and ``require.js``. + +------- +Licence +------- + +``Converse.js`` is released under both the ``MIT`` and ``GPL`` licenses. + +.. _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: http://xmpp.org +.. _MIT: http://opensource.org/licenses/mit-license.php +.. _GPL: http://opensource.org/licenses/gpl-license.php + + +