Diff

mod_conversejs/README.markdown @ 3598:1921ae4449b8

mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat)
author Kim Alvefur <zash@zash.se>
date Thu, 16 May 2019 08:45:41 +0200
parent 3495:5567098a7f91
child 3643:740870196b97
line wrap: on
line diff
--- a/mod_conversejs/README.markdown	Thu May 16 07:46:05 2019 +0200
+++ b/mod_conversejs/README.markdown	Thu May 16 08:45:41 2019 +0200
@@ -48,6 +48,21 @@
 `/conversejs`. More details on configuring HTTP modules in Prosody can
 be found in our [HTTP documentation](http://prosody.im/doc/http).
 
+## Templates
+
+The HTML and JS can be customized either by editing the included
+`template.html` and `template.js` files or configuring your own like:
+
+```lua
+conversejs_html_template = "/path/to/my-template.html"
+conversejs_js_template = "/path/to/my-template.js"
+```
+
+The HTML template uses Prosodys
+[`util.interpolation`][doc:developers:util:interpolation] template 
+library while the JS template has `%s` where generated settings are 
+injected.
+
 Other
 -----
 
@@ -119,4 +134,9 @@
 Compatibility
 =============
 
-Should work with Prosody 0.9 and later. Websocket support requires 0.10.
+  Prosody version   state
+  ----------------- ---------------
+  0.9               Does not work
+  0.10              Should work
+  0.11              Should work
+  trunk             Works