# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1676563567 -3600
# Node ID e6d623bd548ec9b80b9e9ca35284903cf54b0f15
# Parent  41fbed2de4828ce1c60ca4f1d34d50aa1a4bc537
mod_jsxc: Document config options

diff -r 41fbed2de482 -r e6d623bd548e mod_jsxc/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_jsxc/README.markdown	Thu Feb 16 17:06:07 2023 +0100
@@ -0,0 +1,34 @@
+---
+summary: JSXC demo
+---
+
+Try out JSXC easily by serving it from Prosodys built-in HTTP server.
+
+# Configuration
+
+mod_jsxc can be set up to either use resources from a separate HTTP
+server or serve resources from Prosody's built-in HTTP server.
+
+## Using CDN
+
+`jsxc_cdn`
+:   String. Base URL where JSXC resources are served from. Defaults to
+    empty string.
+
+`jsxc_version`
+:   String. Concatenated with the CDN URL. Defaults to empty string.
+
+## Local resources
+
+Download a JSXC release archive and unpack it somewhere on your server.
+
+`jsxc_resources`
+:   String. Path to JSXC resources on the local file system. The target
+    directory should contain a `dist` directory. Disabled by default.
+
+## Other options
+
+`jquery_url`
+:   String. URL or relative path to jQuery. Defaults to
+    `"/share/jquery/jquery.min.js"` which will work with
+    [mod_http_libjs].