From c6839479c3b50c254e76e49c3a1b0d8f048faac5 Mon Sep 17 00:00:00 2001 From: JC Brand Date: Mon, 4 Sep 2017 09:24:38 +0200 Subject: [PATCH] Mention plugin arch in readme. Also, turn the sections about the fiddle example and the generator into notes. --- README.md | 1 + docs/source/plugin_development.rst | 31 ++++++++++++++---------------- index.html | 2 ++ 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 6a9e59246..e8842c290 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,7 @@ which shows you how to use the CDN (content delivery network) to quickly get a d ## 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 - Contacts and groups - Multi-user chat rooms [XEP 45](http://xmpp.org/extensions/xep-0045.html) diff --git a/docs/source/plugin_development.rst b/docs/source/plugin_development.rst index 7e1666693..de1d367df 100644 --- a/docs/source/plugin_development.rst +++ b/docs/source/plugin_development.rst @@ -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 `_. -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 -code required like PHP, Python or Ruby) it runs fine in JSFiddle. + 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. -Here's an Fiddle with a Converse.js plugin that calls `alert` once it gets -initialized and also when a chat message gets rendered: + Here's a Fiddle with a Converse.js plugin that calls `alert` once it gets + 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 -ends with a documented example of a plugin. + The rest of this document explains how to write a plugin for Converse.js and + ends with a documented example of a plugin. -You can use a `Yeoman `_ code generator, called -`generator-conversejs `_ to -generate plugin scaffolding code, which you can use as a starting point and -basis for writing your plugin. + There is a `Yeoman `_ code generator, called + `generator-conversejs `_, which + you can use to generate plugin scaffolding/boilerplate, which you can use as a + starting point and basis for writing your plugin. -Please refer to the `generator-conversejs `_ -README for information on how to use it. + Please refer to the `generator-conversejs `_ + README for information on how to use it. Registering a plugin -------------------- diff --git a/index.html b/index.html index 7fbb58932..b676b2873 100644 --- a/index.html +++ b/index.html @@ -139,6 +139,8 @@
  • Available as overlayed chat boxes or as a fullscreen application. See inverse.chat for the fullscreen version.
    • +
  • Plugin Architecture based on + pluggable.js
  • Presence information (online, busy, away)
  • Single-user chat
  • Contacts and groups