comparison mod_invite/README.markdown @ 2059:e96a86561f3e

mod_invite: Added README.
author Thijs Alkemade <me@thijsalkema.de>
date Wed, 02 Mar 2016 19:17:12 +0100
parents
children 78b7879a04f7
comparison
equal deleted inserted replaced
2058:4b3037c7af62 2059:e96a86561f3e
1 ---
2 labels:
3 - 'Stage-Alpha'
4 summary: 'Allows users to invite new users'
5 ...
6
7 Introduction
8 ============
9
10 This module allows users with an account to generate single-use invite URLs
11 using an ad-hoc command. The invite URLs allow new users to create an account
12 even if public registration is disabled.
13
14 After the account is created, the inviter and the invitee are automatically
15 added to the other's roster. The inviter of a user is stored, so can be used
16 later (for example, for detecting spammers).
17
18 This module depends on Prosody's internal webserver.
19
20 Compatibility
21 =============
22
23 ----- -------
24 0.9 Works
25 ----- -------