Commit 888cd8c9 authored by JC Brand's avatar JC Brand

Mention the new CDN

parent ffa86617
......@@ -8,10 +8,18 @@ It enables you to add chat functionality to your website, independent of
any specific backend. You will however need an XMPP server to connect
to, either your own, or a public one.
Features
--------
## Demo
It has the following features:
A live demo is available at [https://conversejs.org](https://conversejs.org)
## Documentation
The developer/integrator documentation can be found at [https://conversejs.org/docs/html](https://conversejs.org/docs/html).
You'll probably want to begin with the [quickstart guide](https://conversejs.org/docs/html/quickstart.html),
which shows you how to use the CDN (content delivery network) to quickly get a demo up and running.
## Features
- Single-user chat
- Multi-user chat rooms [XEP 45](http://xmpp.org/extensions/xep-0045.html)
......@@ -24,6 +32,7 @@ It has the following features:
- Roster item exchange [XEP 144](http://xmpp.org/extensions/tmp/xep-0144-1.1.html)
- Chat statuses (online, busy, away, offline)
- Custom status messages
- Desktop notifications
- Typing and state notifications [XEP 85](http://xmpp.org/extensions/xep-0085.html)
- Messages appear in all connnected chat clients [XEP 280](http://xmpp.org/extensions/xep-0280.html)
- Third person "/me" messages [XEP 245](http://xmpp.org/extensions/xep-0245.html)
......@@ -33,19 +42,7 @@ It has the following features:
- Off-the-record encryption
- Translated into 16 languages
Screencasts
-----------
*Note: These screencasts are already quite old! Converse.js has grown and evolved further since then.*
- [In a static HTML page](http://opkode.com/media/blog/2013/04/02/converse.js-xmpp-instant-messaging-with-javascript).
Here we chat to external XMPP accounts on Jabber.org and Gmail.
- [Integrated into a Plone site](http://opkode.com/media/blog/instant-messaging-for-plone-with-javascript-and-xmpp)
via collective.xmpp.chat.
- [Off-the-record encryption](https://opkode.com/media/blog/2013/11/11/conversejs-otr-support)
in Converse 0.7.
### Integration into other frameworks
## Integration into other frameworks
- **[Django](http://www.djangoproject.com)**: [django-conversejs](https://pypi.python.org/pypi/django-conversejs) or [django-xmpp](https://github.com/fpytloun/django-xmpp)
- **[Plone](http://plone.org)**: [collective.xmpp.chat](http://github.com/collective/collective.xmpp.chat)
......@@ -55,30 +52,28 @@ Screencasts
- **[Alfresco](http://www.alfresco.com)**: [alfresco-js-chat-share](https://github.com/keensoft/alfresco-js-chat-share)
- **[Friendica](http://friendica.com)**: [converse](https://github.com/friendica/friendica-addons/tree/master/xmpp/converse)
Demo
----
## Screencasts
A live demo is available at [https://conversejs.org](https://conversejs.org)
*Note: These screencasts are already quite old! Converse.js has grown and evolved further since then.*
- [In a static HTML page](http://opkode.com/media/blog/2013/04/02/converse.js-xmpp-instant-messaging-with-javascript).
Here we chat to external XMPP accounts on Jabber.org and Gmail.
- [Integrated into a Plone site](http://opkode.com/media/blog/instant-messaging-for-plone-with-javascript-and-xmpp)
via collective.xmpp.chat.
- [Off-the-record encryption](https://opkode.com/media/blog/2013/11/11/conversejs-otr-support)
in Converse 0.7.
Tests
-----
## Tests
We use behavior-driven tests written with [jasmine.js](http://pivotal.github.io/jasmine).
Open [tests.html](https://github.com/jcbrand/converse.js/blob/master/tests.html) in your browser, and the tests will run automatically.
Documentation
-------------
The developer/integrator documentation can be found at [https://conversejs.org/docs/html](https://conversejs.org/docs/html).
Licence
-------
## Licence
`Converse.js` is released under the [Mozilla Public License (MPL)](https://www.mozilla.org/MPL/2.0/index.txt).
Support
-------
## Support
For support queries and discussions, please join the mailing list: <conversejs@librelist.com>
......
......@@ -6,25 +6,24 @@
Quickstart (to get a demo up and running)
=========================================
When you download a specific release of *Converse.js* there will be two minified files inside the zip file.
Converse.js has a [CDN](https://en.wikipedia.org/wiki/Content_delivery_network), provided by [KeyCDN](http://keycdn.com/), which hosts its Javascript and CSS files.
* dist/converse.js
* css/converse.min.css
The latest versions of these files are available at these URLs:
You can include these two files inside the *<head>* element of your website via the *script* and *link* tags:
* https://cdn.conversejs.org/dist/converse.min.js
* https://cdn.conversejs.org/css/converse.min.css
.. code-block:: html
For a specific version of the files, you can put the version in the URL, as so:
* https://cdn.conversejs.org/1.0.3/dist/converse.min.js
* https://cdn.conversejs.org/1.0.3/css/converse.min.css
<link rel="stylesheet" type="text/css" media="screen" href="css/converse.min.css">
<script src="dist/converse.js"></script>
You can include these two URLs inside the *<head>* element of your website via the *script* and *link* tags:
.. code-block:: html
.. note::
Note that the Javascript file ``converse.js`` contains **all** the dependencies
of converse.js and is unminified, so it's very large. Before you host
converse.js yourself, you'll definitely want to generate a minified version
first. There are various ways to do this. One option is to simply run ``make dist``,
in your converse.js repo checkout. A minified file ``dist/converse.min.js`` will
then be created for you, which you can use.
<link rel="stylesheet" type="text/css" media="screen" href="https://cdn.conversejs.org/css/converse.min.css">
<script src="https://cdn.conversejs.org/dist/converse.min.js"></script>
You need to initialize Converse.js with configuration settings according to your requirements.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment