Update readme and add CHANGES.rst

This commit is contained in:
JC Brand 2013-03-01 10:55:54 +02:00
parent 10be57aec4
commit 7a38d58e83
2 changed files with 18 additions and 4 deletions

8
CHANGES.rst Normal file
View File

@ -0,0 +1,8 @@
Changelog
=========
0.1 - Unreleased
----------------
- Created [jcbrand]
- Performance enhancements for rosters [ichim-david]
- Add "Connecting to chat..." info [alecghica]

View File

@ -4,7 +4,16 @@ converse.js
``Converse.js`` implements an XMPP_ based instant messaging client in the browser.
*Warning*: *This library is still heavily under development and not usable currently.*
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
@ -22,9 +31,6 @@ It has the following features:
* 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.
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_,