Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
converse.js
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
converse.js
Commits
0a02b62c
Commit
0a02b62c
authored
Oct 26, 2018
by
JC Brand
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update build docs on converse-headless and add README
parent
4f72b099
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
27 additions
and
4 deletions
+27
-4
docs/source/builds.rst
docs/source/builds.rst
+11
-4
src/headless/README.md
src/headless/README.md
+16
-0
No files found.
docs/source/builds.rst
View file @
0a02b62c
...
@@ -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.
src/headless/README.md
0 → 100644
View file @
0a02b62c
# 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.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment