From 24154ebb09c39a7ed9bd6aa338020c0749563679 Mon Sep 17 00:00:00 2001 From: William Kray Date: Tue, 8 Dec 2020 11:28:34 -0800 Subject: [PATCH] add readme and license --- LICENSE | 21 +++++++++++++++++++++ README.md | 11 +++++++++++ 2 files changed, 32 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d9d4e3d --- /dev/null +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f356043 --- /dev/null +++ b/README.md @@ -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!