No Description

JC Brand 9fb409136f Add base.css for basic non-converse specific styles 12 years ago
Libraries 4989b4295b Add strophe.vcard.js 12 years ago
images 0c8c4bf2cd Add missing images 12 years ago
spec d7cb92c7af Merge pull request #3 from ichim-david/master 12 years ago
.gitmodules 9abb9e36bf Add logging submodule (from Patternslib) 12 years ago
CHANGES.rst a9df31e184 Added changes.rst entry for this pull request 12 years ago
CONTRIBUTING.rst 8b84ce346e Rename to contributing. #4 12 years ago
LICENSE_GPL.txt 6e372919ad Add converse.js and the license files. 12 years ago
LICENSE_MIT.txt b6af624b14 Code clean up 12 years ago
README.rst 7a38d58e83 Update readme and add CHANGES.rst 12 years ago
TODO fcb0b7bb57 Add TODO file 12 years ago
base.css 9fb409136f Add base.css for basic non-converse specific styles 12 years ago
converse.css daa31794d7 Render the vCard profile picture 12 years ago
converse.js 4b670228ff Fix canvas image ratio (don't stretch or squash) 12 years ago
index.html 9fb409136f Add base.css for basic non-converse specific styles 12 years ago
main.js c17ffdb98a Added functionality to connect to an XMPP server. 12 years ago
tests.html 85e419afc5 Add test.html for loading tests in browser and tests_main.js for calling them 12 years ago
tests_main.js b6af624b14 Code clean up 12 years ago

README.rst

===========
converse.js
===========

``Converse.js`` implements an XMPP_ based instant messaging client in the browser.

It is used by collective.xmpp.chat_, which is a Plone_ instant messaging add-on.

The ultimate goal is to enable anyone to add Jabber chat functionality to their websites,
regardless of the server backend.

Currently this is not yet the case, as the code makes ajax calls to the (Plone) backend
to fetch user info. This should be replaced with VCards (we're currently
working on it).

This library is therefore not (yet) usable independently.

--------
Features
--------

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

A screencast of ``Converse.js`` in action via ``collective.xmpp.chat`` can be seen here_.

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
.. _here: http://opkode.com/media/blog/instant-messaging-for-plone-with-javascript-and-xmpp