Mercurial > prosody-modules

diff mod_easy_invite/README.markdown @ 3778:7209f481bcfe

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_easy_invite: Add prosodyctl command to generate account invites
author Matthew Wild <mwild1@gmail.com>
date Fri, 27 Dec 2019 11:00:43 +0000
parents 26559776a87e
children 28deb30a5272
line wrap: on
line diff
--- a/mod_easy_invite/README.markdown	Fri Dec 27 10:41:01 2019 +0000
+++ b/mod_easy_invite/README.markdown	Fri Dec 27 11:00:43 2019 +0000
@@ -26,6 +26,16 @@
 contact invites, but new contacts will be required to register an account
 on a different server.
 
+# Usage
+
+Users can use the "New Invite" ad-hoc command through their client.
+
+Admins can create registration links using prosodyctl, e.g.
+
+```
+prosodyctl mod_easy_invite example.com register
+```
+
 # Compatibility
 
 0.11 and later.