Updated readme
This commit is contained in:
parent
d98b08fbd7
commit
d7bb13500d
41
README.md
41
README.md
@ -1,4 +1,43 @@
|
|||||||
|
===========
|
||||||
converse.js
|
converse.js
|
||||||
===========
|
===========
|
||||||
|
|
||||||
Web-based XMPP Instant Messaging client written in javascript
|
``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
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user