Diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_vjud/README.wiki	Mon Aug 24 16:43:56 2015 +0200
@@ -0,0 +1,47 @@
+#summary XEP-0055: Jabber Search
+#labels Stage-Alpha
+
+= Introduction =
+
+Basic implementation of [http://xmpp.org/extensions/xep-0055.html XEP-0055: Jabber Search].
+
+= Details =
+
+This module has two modes.  One mode requires users to opt-in to be
+searchable, then allows users to search the list of those users.  The
+second mode allows search accross all users.
+
+= Usage =
+
+First copy the module to the prosody plugins directory.
+
+Then add "vjud" to your modules_enabled list:
+{{{
+    modules_enabled = {
+                    -- ...
+                    "vjud",
+                    -- ...
+		}
+}}}
+
+
+Alternatively, you can load it as a component:
+
+{{{
+	Component "search.example.com" "vjud"
+}}}
+
+(Some old clients require this)
+
+= Configuration =
+
+|| Option || Default || Description ||
+|| vjud_mode || "opt-in" || Defines how the module behaves ||
+
+= Compatibility =
+|| 0.8 || Works, but only the opt-in mode ||
+|| 0.9 || Works ||
+|| trunk || Works ||
+
+Note that the version for 0.8 and 0.9 are slightly different.
+