Add quickstart README

This commit is contained in:
2026-04-05 23:59:05 +02:00
parent c86f67a592
commit af91eb9ef6

22
README.md Normal file
View File

@@ -0,0 +1,22 @@
# DarkPeers Mod Queue Helper
Quality-gate checks for DarkPeers moderators — torrent validation, title compliance, SRRDB & Prowlarr integrations.
## Install
1. Install [Tampermonkey](https://www.tampermonkey.net/) in your browser
2. Click the link below to install the script:
**[Install userscript](https://gitea.computerliebe.org/Procuria/dp-modq-helper/raw/branch/main/modq-helper-darkpeers.user.js)**
3. Tampermonkey will show a confirmation dialog — click **Install**
The script runs automatically on `https://darkpeers.org/torrents/*` pages.
## Updates
Tampermonkey checks for updates automatically. To force a check: Tampermonkey icon > Utilities > Check for userscript updates.
## Optional: Prowlarr Integration
Open the settings via Tampermonkey menu > **ModQ Helper Settings** and enter your Prowlarr URL and API key to enable cross-seed detection.