changeset 3075:4e8b5ea7f4c2

mod_muc_lang: Add a README
author Kim Alvefur <zash@zash.se>
date Wed, 30 May 2018 09:31:37 +0200
parents 57396a32fc05
children 091b042cada0
files mod_muc_lang/README.markdown
diffstat 1 files changed, 26 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_muc_lang/README.markdown	Wed May 30 09:31:37 2018 +0200
@@ -0,0 +1,26 @@
+# Introduction
+
+This module adds support for advertising the language used in a room.
+
+# Configuring
+
+``` {.lua}
+Component "rooms.example.net" "muc"
+modules_enabled = {
+    "muc_lang";
+}
+```
+
+The room language is specified in a new field in the room configuration
+dialog, accessible through compatible clients.
+
+Use [language codes](https://en.wikipedia.org/wiki/ISO_639) like `en`,
+`fr`, `de` etc.
+
+# Compatibility
+
+Meant for use with Prosody 0.10.x
+
+Native support was [added in Prosody
+trunk/0.11](https://hg.prosody.im/trunk/rev/9c90cd2fc4c3), so there is
+no need for this module.