Diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_invites_register_web/README.markdown	Fri Sep 11 13:51:54 2020 +0100
@@ -0,0 +1,34 @@
+---
+labels:
+- 'Stage-Beta'
+summary: 'Register accounts via the web using invite tokens'
+...
+
+Introduction
+============
+
+This module is part of the suite of modules that implement invite-based
+account registration for Prosody. The other modules are:
+
+- mod_invites
+- mod_invites_adhoc
+- mod_invites_page
+- mod_invites_register
+- mod_invites_register_web
+- mod_register_apps
+
+For details and a full overview, start with the mod_invites documentation.
+
+Details
+=======
+
+mod_invites_register_web implements a web-based registration form that
+validates invite tokens. It also supports guiding the user through client
+download and configuration via mod_register_apps.
+
+There is no specific configuration for this module (though it uses the
+optional `site_name` to override the displayed site name.
+
+This module depends on mod_invites_page solely for the case where an invalid
+invite token is received - it will redirect to mod_invites_page so that an
+appropriate error can be served to the user.