Chapril/xmpp.chapril.org-conversejs
Chapril/xmpp.chapril.org-conversejs
25
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

Update build docs on converse-headless and add README

Browse Source
This commit is contained in:
JC Brand 2018-10-26 16:07:37 +02:00
parent 4f72b0999b
commit 0a02b62cd8
2 changed files with 27 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/source/builds.rst
View File

@ -101,10 +101,17 @@ To generate this bundle, you can run:
Headless build
--------------
There is also the option of making a headless build of Converse.
Converse also has a special build called the `headless build`.
This is a build without any UI code but still containing the core functionality of
maintaining a roster, chats and messages.
You can generate it by running ``make dist/converse-headless.js``
The file `src/headless.js <https://github.com/jcbrand/converse.js/blob/master/src/headless.js>`_
The headless build is a bundle of all the non-UI parts of Converse, and its aim
is to provide you with an XMPP library (and application) on which you can build
your own UI.
It's also installable as `@converse/headless <https://www.npmjs.com/package/@converse/headless>`_.
The main distribution of Converse relies on the headless build.
The file `src/headless/headless.js <https://github.com/jcbrand/converse.js/blob/master/src/headless/headless.js>`_
is used to determine which plugins are included in the build.

16
src/headless/README.md Normal file
View File

@ -0,0 +1,16 @@
# Converse Headless
[Converse](https://conversejs.org) has a special build called the *headless build*.
You can generate it yourself by running ``make dist/converse-headless.js``
The headless build is a bundle of all the non-UI parts of Converse, and its aim
is to provide you with an XMPP library (and application) on which you can build
your own UI.
It's also installable with NPM/Yarn as [@converse/headless](https://www.npmjs.com/package/@converse/headless).
The main distribution of Converse relies on the headless build.
The file [src/headless/headless.js](https://github.com/jcbrand/converse.js/blob/master/src/headless/headless.js)
is used to determine which plugins are included in the build.