Diff

mod_jid_prep/README.md @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 3669:14ad3f853c51
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_jid_prep/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,29 @@
+---
+labels:
+- 'Stage-Alpha'
+summary: 'Implement XEP-0328: JID Prep for clients'
+...
+
+Introduction
+============
+
+This is a plugin that implements the JID prep protocol defined in
+<https://xmpp.org/extensions/xep-0328.html>
+
+Details
+=======
+
+JID prep requests can happen over XMPP using the protocol defined in the
+document linked above, or alternatively over HTTP. Simply request:
+
+    http://server:5280/jid_prep/USER@HOST
+
+The result will be the stringprepped JID, or a 400 Bad Request if the
+given JID is invalid.
+
+Compatibility
+=============
+
+  ----- -------
+  0.9   Works
+  ----- -------