Update the README

This commit is contained in:
Scott Wallace 2021-06-01 17:10:57 +01:00
parent 451de8d5d6
commit d4aa3b8b12
Signed by: scott
GPG key ID: AA742FDC5AFE2A72

View file

@ -1,6 +1,8 @@
# Shameotron # Shameotron
A simple [maubot](https://github.com/maubot/maubot) plugin that displays homeserver software versions. A simple [maubot](https://github.com/maubot/maubot) plugin that displays homeserver software versions.
After installing the Python dependencies, run `mbc build` to build the `.mbp` plugin file.
## Usage ## Usage
* `!shame` - Reply with a list of homeservers and their respective running versions. * `!shame` - Reply with a list of homeservers and their respective running versions.
* `!shame server.example.com` - Reply with the version for the homeserver provided, e.g. `server.example.com`. * `!shame server.example.com` - Reply with the version for the homeserver provided, e.g. `server.example.com`.