diff --git a/README.md b/README.md index 01b396f..767622e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ -# remote_instance_actions +# Remote Instance Actions -Script to perform moderation actions on remote instances from the Mastodon frontend (and technically, a tool to generate the script). \ No newline at end of file +![](https://hollymcfarland.com/remote_instance_actions/ria.png) + +*Quickly suspend or silence remote instances from the Mastodon frontend* + +### What is this? + +A userscript to make blocking remote instances on Mastodon a less tedious and time-consuming task. + +### How do I install it? + +First, install Tampermonkey. Then, visit the [installation website](https://hollymcfarland.com/remote_instance_actions). + +### Why have a whole installation website for a userscript? + +It fills in the `@match` directives for whatever instances are relevant to the user, using GET parameters so Tampermonkey's update functionality will continue to work. + +## TODO + +- Figure out why it doesn't work on Firefox