Commit 0a02b62c authored by JC Brand's avatar JC Brand

Update build docs on converse-headless and add README

parent 4f72b099
...@@ -101,10 +101,17 @@ To generate this bundle, you can run: ...@@ -101,10 +101,17 @@ To generate this bundle, you can run:
Headless build 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 You can generate it by running ``make dist/converse-headless.js``
maintaining a roster, chats and messages.
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. is used to determine which plugins are included in the build.
# 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.
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