JC Brand
07e87d7b50
docs w.r.t using development files with(out) require.js. Updates #9
|
12 年 前 | |
|---|---|---|
| Libraries | 12 年 前 | |
| docs | 12 年 前 | |
| images | 12 年 前 | |
| javascripts | 12 年 前 | |
| locale | 12 年 前 | |
| spec | 12 年 前 | |
| stylesheets | 12 年 前 | |
| .gitignore | 12 年 前 | |
| .gitmodules | 12 年 前 | |
| .nojekyll | 12 年 前 | |
| CHANGES.rst | 12 年 前 | |
| CNAME | 12 年 前 | |
| CONTRIBUTING.rst | 12 年 前 | |
| Gruntfile.js | 12 年 前 | |
| LICENSE_GPL.txt | 12 年 前 | |
| LICENSE_MIT.txt | 12 年 前 | |
| Makefile | 12 年 前 | |
| README.rst | 12 年 前 | |
| TODO | 12 年 前 | |
| build.js | 12 年 前 | |
| converse.css | 12 年 前 | |
| converse.js | 12 年 前 | |
| converse.min.css | 12 年 前 | |
| converse.min.js | 12 年 前 | |
| index.html | 12 年 前 | |
| main.js | 12 年 前 | |
| mock.js | 12 年 前 | |
| non_amd.html | 12 年 前 | |
| package.json | 12 年 前 | |
| params.json | 12 年 前 | |
| tests.html | 12 年 前 | |
| tests_main.js | 12 年 前 |
README.rst
===========
converse.js
===========
Converse.js_ is a web based `XMPP/Jabber`_ instant messaging client.
It is used by collective.xmpp.chat_, which is a Plone_ instant messaging add-on.
The ultimate goal is to enable anyone to add chat functionality to their websites, independent of any backend.
You will however need an XMPP server to connect to, either your own, or a public one.
--------
Features
--------
It has the following features:
* Manually or automically subscribe to other users.
* Accept or decline contact requests
* Chat status (online, busy, away, offline)
* Custom status messages
* Typing notifications
* Third person messages (/me )
* Multi-user chat in chatrooms
* Chatroom Topics
* vCard support
-----------
Screencasts
-----------
* `In a static HTML page`_. Here we chat to external XMPP accounts on Jabber.org and Gmail.
* `Integrated into a Plone site`_ via collective.xmpp.chat.
------------
Dependencies
------------
It depends on quite a few third party libraries, including:
* strophe.js_
* backbone.js_
* require.js_
-------
Licence
-------
``Converse.js`` is released under both the MIT_ and GPL_ licenses.
.. _Converse.js: http://conversejs.org
.. _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/Jabber`: 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
.. _Screencast2: http://opkode.com/media/blog/2013/04/02/converse.js-xmpp-instant-messaging-with-javascript
.. _`Integrated into a Plone site`: http://opkode.com/media/blog/instant-messaging-for-plone-with-javascript-and-xmpp
.. _`In a static HTML page`: http://opkode.com/media/blog/2013/04/02/converse.js-xmpp-instant-messaging-with-javascript
converse.js
===========
Converse.js_ is a web based `XMPP/Jabber`_ instant messaging client.
It is used by collective.xmpp.chat_, which is a Plone_ instant messaging add-on.
The ultimate goal is to enable anyone to add chat functionality to their websites, independent of any backend.
You will however need an XMPP server to connect to, either your own, or a public one.
--------
Features
--------
It has the following features:
* Manually or automically subscribe to other users.
* Accept or decline contact requests
* Chat status (online, busy, away, offline)
* Custom status messages
* Typing notifications
* Third person messages (/me )
* Multi-user chat in chatrooms
* Chatroom Topics
* vCard support
-----------
Screencasts
-----------
* `In a static HTML page`_. Here we chat to external XMPP accounts on Jabber.org and Gmail.
* `Integrated into a Plone site`_ via collective.xmpp.chat.
------------
Dependencies
------------
It depends on quite a few third party libraries, including:
* strophe.js_
* backbone.js_
* require.js_
-------
Licence
-------
``Converse.js`` is released under both the MIT_ and GPL_ licenses.
.. _Converse.js: http://conversejs.org
.. _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/Jabber`: 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
.. _Screencast2: http://opkode.com/media/blog/2013/04/02/converse.js-xmpp-instant-messaging-with-javascript
.. _`Integrated into a Plone site`: http://opkode.com/media/blog/instant-messaging-for-plone-with-javascript-and-xmpp
.. _`In a static HTML page`: http://opkode.com/media/blog/2013/04/02/converse.js-xmpp-instant-messaging-with-javascript