From 886dc76bf49980007f034ca5f164ac9cb136b36d Mon Sep 17 00:00:00 2001 From: Kavin <20838718+FireMasterK@users.noreply.github.com> Date: Mon, 24 Oct 2022 10:20:10 +0100 Subject: [PATCH] readme: initial version --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6387427..93eb54b 100644 --- a/README.md +++ b/README.md @@ -1 +1,13 @@ -# sponsorblock-mirror \ No newline at end of file +# sponsorblock-mirror + +This is a Rust-based mirror of the [SponsorBlock](https://sponsor.ajay.app) API. + +It also uses [sb-mirror](https://github.com/mchangrh/sb-mirror) for mirroring the CSV dumps via rsync. + +## Instances + +- [sponsorblock.kavin.rocks](https://sponsorblock.kavin.rocks) - 🇩🇪 (main instance) + +Feel free to add your instance to this list by making a pull request. + +You can also configure Piped-Backend to use your mirror by changing the `SPONSORBLOCK_SERVERS` configuration value.