Matrix-Mirrors/maubot-invite
1
0
Fork 0
mirror of https://github.com/williamkray/maubot-invite.git synced 2024-10-01 01:25:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

add readme and license

Browse Source
This commit is contained in:
William Kray 2020-12-08 11:28:34 -08:00
parent c33f0f4ae4
commit 24154ebb09
2 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2018 Jona Abdinghoff
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

11
README.md Normal file
View File

@ -0,0 +1,11 @@
this is a simple [maubot](https://github.com/maubot/maubot) plugin which interacts with a [matrix-registration](https://github.com/zeratax/matrix-registration) deployment and generates invite tokens.
modify the config to point to your matrix-registration url, include your admin secret to authenticate, and ensure that you're in the list of approved users.
once your bot is running, simply use the command
!invite generate
to generate a token with some generic text you can copy-paste when sharing it with your invitee!
future plans to manage existing tokens seem like a good idea, although i don't know if i'll have the energy to implement. PRs are welcome!