diff --git a/README.md b/README.md index 382de1be..1e7068ec 100644 --- a/README.md +++ b/README.md @@ -48,17 +48,24 @@ across an entire homeserver. The main difference from Mjolnir is that it is no longer necessary to use commands for some functions. Banning a user in a protected room from your Matrix client will cause Draupnir to show a prompt in the management room, -which will offer to add the ban to a policy list. +which will offer to add the ban to a policy list[^the-gif-width]. + +![A demo showing a propagation prompt](docs/ban-propagation-prompt.gif) If you do still wish to use the ban command, please note that users and other entities that are being banned are now the first argument to the ban command. It is now also possible to provide only the entity to Draupnir and have Draupnir prompt you for the policy list and the ban reason. +![A demo showing the ban command](docs/ban-command-prompt.gif) + In general, any command that has been migrated to the new interface will feature better error messages for common problems and allow admins to trace the cause of unexpected errors much more easily. +[^the-gif-width]: Yes, i know they don't align horizontally, +you are welcome to suggest how this should be fixed. + ## Setting up See the [setup documentation](docs/setup.md) for first-time setup documentation. diff --git a/docs/ban-command-prompt.gif b/docs/ban-command-prompt.gif new file mode 100644 index 00000000..8cdaaadb --- /dev/null +++ b/docs/ban-command-prompt.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6d3506f39bd50b3e986ba272b14c0c8cc77094f2fe75ab88cca6b3144d63ec5a +size 288619 diff --git a/docs/ban-propagation-prompt.gif b/docs/ban-propagation-prompt.gif new file mode 100644 index 00000000..79c8d89c --- /dev/null +++ b/docs/ban-propagation-prompt.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0d23fd7a118a4db0ef60e44c70f3c6d258d830cdb01ebb3496cd2971a4ef0e76 +size 415683