From 7a38d58e83bb1e62e60a6bdbe0bf6e00e40ec33e Mon Sep 17 00:00:00 2001 From: JC Brand Date: Fri, 1 Mar 2013 10:55:54 +0200 Subject: [PATCH] Update readme and add CHANGES.rst --- CHANGES.rst | 8 ++++++++ README.rst | 14 ++++++++++---- 2 files changed, 18 insertions(+), 4 deletions(-) create mode 100644 CHANGES.rst diff --git a/CHANGES.rst b/CHANGES.rst new file mode 100644 index 000000000..5107f392c --- /dev/null +++ b/CHANGES.rst @@ -0,0 +1,8 @@ +Changelog +========= + +0.1 - Unreleased +---------------- +- Created [jcbrand] +- Performance enhancements for rosters [ichim-david] +- Add "Connecting to chat..." info [alecghica] diff --git a/README.rst b/README.rst index 52ebbcf46..dd3cbe146 100644 --- a/README.rst +++ b/README.rst @@ -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_,