# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1518749571 -3600
# Node ID ed5ad4fd5bdd2f8935f5a9f227cdd037274f8fe0
# Parent  d6badf56ab5f96b7b193e10ee894dd04dc4686e8
mod_conversejs: Add a readme

diff -r d6badf56ab5f -r ed5ad4fd5bdd mod_conversejs/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_conversejs/README.markdown	Fri Feb 16 03:52:51 2018 +0100
@@ -0,0 +1,30 @@
+---
+depends:
+- 'mod\_bosh'
+- 'mod\_websocket'
+provides:
+- http
+title: 'mod\_conversejs'
+---
+
+Introduction
+============
+
+This module serves a small snippet of HTML that loads
+[Converse.js](https://conversejs.org/), configured to work with the
+VirtualHost that it is loaded onto.
+
+Configuration
+=============
+
+The module itself has no configuration. It uses
+[authentication settings][doc:authentication] to determine whether to
+configure Converse.js to use `login` or `anonymous` mode.
+
+It also determines the [BOSH][mod_bosh] and [WebSocket][mod_websocket]
+URL automatically, see their respective documentation for how to configure
+them.
+
+See Prosodys [HTTP configuration][doc:http] for HTTP related options.
+
+