Mercurial > prosody-modules

changeset 2321:d9c19ee16f2e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_server_contact_info/README: Update
author Kim Alvefur <zash@zash.se>
date Sat, 01 Oct 2016 17:20:31 +0200
parents d6a3362ca256
children 73fbfd1e820b
files mod_server_contact_info/README.markdown
diffstat 1 files changed, 17 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/mod_server_contact_info/README.markdown	Sat Oct 01 17:16:39 2016 +0200
+++ b/mod_server_contact_info/README.markdown	Sat Oct 01 17:20:31 2016 +0200
@@ -1,19 +1,25 @@
 ---
 labels:
-- 'Stage-Alpha'
+- 'Stage-Beta'
 summary: Contact Addresses for XMPP Services
-...
+---
 
 Introduction
 ============
 
-This module implements [XEP-0157: Contact Addresses for XMPP
-Services](http://xmpp.org/extensions/xep-0157.html).
+This module lets you advertise various contact addresses for your XMPP
+service via [XEP-0157].
 
 Configuration
 =============
 
-``` lua
+Various types of contact addresses can be set via the single table
+option `contact_info`. Each field is either a string or a list of
+strings. Each string should be an URI.
+
+An example showing all possible fields:
+
+``` {.lua}
 contact_info = {
   abuse = { "mailto:abuse@shakespeare.lit", "xmpp:abuse@shakespeare.lit" };
   admin = { "mailto:admin@shakespeare.lit", "xmpp:admin@shakespeare.lit" };
@@ -24,11 +30,13 @@
 };
 ```
 
-The default is based on the `admins` config variable.
+If not set, the `admins` option will be used.
 
 Compatibility
 =============
 
-  ------- -------
-  trunk   Works
-  ------- -------
+  ------ ---------------
+  0.10   works
+  0.9    works
+  0.8    does not work
+  ------ ---------------