add readme

benjick · Jun 23, 2024 · fcf0bc6 · fcf0bc6
1 parent 53a814b
commit fcf0bc6
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 1 deletion.
diff --git a/.github/images/after.png b/.github/images/after.png
diff --git a/.github/images/before.png b/.github/images/before.png
diff --git a/.github/images/prowlarr.png b/.github/images/prowlarr.png
diff --git a/README.md b/README.md
@@ -1 +1,25 @@
-# prowlerr-proxy
+# prowlarr-proxy
+
+### Remove or replace Prowlarrs suffix from indexer name: ` (Prowlarr)`
+
+Before:
+
+![Before image](./.github/images/before.png)
+
+After (with emoji suffix):
+
+![After image](./.github/images/after.png)
+
+## Running:
+
+```sh
+docker run -p 3000:3000 -v $(pwd)/config:/config -it ghcr.io/benjick/prowlarr-proxy:latest
+```
+
+Edit `./config/config.yml` with your desired values
+
+Finally update your Application in Prowlarr to use the proxy:
+
+![Prowlarr settings](./.github/images/prowlarr.png)
+
+Press "Sync App Indexers" to update the indexers