Mention plugin arch in readme.

Also, turn the sections about the fiddle example and the generator into notes.
This commit is contained in:
JC Brand 2017-09-04 09:24:38 +02:00
parent 8416143c65
commit c6839479c3
3 changed files with 17 additions and 17 deletions

View File

@ -37,6 +37,7 @@ which shows you how to use the CDN (content delivery network) to quickly get a d
## Features ## Features
- A [plugin architecture](https://conversejs.org/docs/html/plugin_development.html) based on [pluggable.js](https://jcbrand.github.io/pluggable.js/)
- Single-user chat - Single-user chat
- Contacts and groups - Contacts and groups
- Multi-user chat rooms [XEP 45](http://xmpp.org/extensions/xep-0045.html) - Multi-user chat rooms [XEP 45](http://xmpp.org/extensions/xep-0045.html)

View File

@ -30,30 +30,27 @@ To more deeply understand how this plugin architecture works, please read the
and to understand its inner workins, please refer to the `annotated source code and to understand its inner workins, please refer to the `annotated source code
<https://jcbrand.github.io/pluggable.js/docs/pluggable.html>`_. <https://jcbrand.github.io/pluggable.js/docs/pluggable.html>`_.
Trying out a plugin in JSFiddle .. note:: **Trying out a plugin in JSFiddle**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Because Converse.js consists only of JavaScript, HTML and CSS (with no backend Because Converse.js consists only of JavaScript, HTML and CSS (with no backend
code required like PHP, Python or Ruby) it runs fine in JSFiddle. code required like PHP, Python or Ruby) it runs fine in JSFiddle.
Here's an Fiddle with a Converse.js plugin that calls `alert` once it gets Here's a Fiddle with a Converse.js plugin that calls `alert` once it gets
initialized and also when a chat message gets rendered: initialized and also when a chat message gets rendered: https://jsfiddle.net/4drfaok0/15/
https://jsfiddle.net/4drfaok0/15/
Generating a plugin with Yeoman .. note:: **Generating a plugin with Yeoman**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The rest of this document explains how to write a plugin for Converse.js, and The rest of this document explains how to write a plugin for Converse.js and
ends with a documented example of a plugin. ends with a documented example of a plugin.
You can use a `Yeoman <http://yeoman.io/>`_ code generator, called There is a `Yeoman <http://yeoman.io/>`_ code generator, called
`generator-conversejs <https://github.com/jcbrand/generator-conversejs>`_ to `generator-conversejs <https://github.com/jcbrand/generator-conversejs>`_, which
generate plugin scaffolding code, which you can use as a starting point and you can use to generate plugin scaffolding/boilerplate, which you can use as a
basis for writing your plugin. starting point and basis for writing your plugin.
Please refer to the `generator-conversejs <https://github.com/jcbrand/generator-conversejs>`_ Please refer to the `generator-conversejs <https://github.com/jcbrand/generator-conversejs>`_
README for information on how to use it. README for information on how to use it.
Registering a plugin Registering a plugin
-------------------- --------------------

View File

@ -139,6 +139,8 @@
<li>Available as overlayed chat boxes or as a fullscreen application. <li>Available as overlayed chat boxes or as a fullscreen application.
See <a href="https://inverse.chat" target="_blank" rel="noopener">inverse.chat</a> for the fullscreen version. See <a href="https://inverse.chat" target="_blank" rel="noopener">inverse.chat</a> for the fullscreen version.
</li> </li>
<li><a href="https://conversejs.org/docs/html/plugin_development.html">Plugin Architecture</a> based on
<a href="https://jcbrand.github.io/pluggable.js/" target="_blank" rel="noopener">pluggable.js</a></li>
<li>Presence information (online, busy, away)</li> <li>Presence information (online, busy, away)</li>
<li>Single-user chat</li> <li>Single-user chat</li>
<li>Contacts and groups</li> <li>Contacts and groups</li>