chase
/
lidarr-true-singles
1
0
Fork 0
Code Issues Pull Requests 2 Actions Packages Projects Releases Wiki Activity

Add more detail to how the script works. [skip publish]

This commit is contained in:
Chase 2023-01-25 18:22:38 -06:00 committed by GitHub
parent 614d61854b
commit 3682fab548
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -22,12 +22,19 @@ docker run --rm \
ghcr.io/chxseh/lidarr-true-singles:latest
```
| Environment Variable | Description | Default |
| -------------------- | ----------------------------------------------------------------------------------------------- | --------------------- |
| LIDARR_URL | The URL to your Lidarr instance | http://localhost:8686 |
| LIDARR_API_KEY | Your Lidarr API Key | |
| UNMONITOR | Whether to unmonitor the tracks or not | false |
| OUTPUT_UNMONITORED | Print unmonitored singles that are downloaded. Note that this overrides the `UNMONITOR` option. | false |
| Environment Variable | Description | Default |
| -------------------- | ----------------------------------------------------------------------------------------------- | ----------------------- |
| `LIDARR_URL` | The URL to your Lidarr instance | `http://localhost:8686` |
| `LIDARR_API_KEY` | Your Lidarr API Key | |
| `UNMONITOR` | Whether to unmonitor the tracks or not | `false` |
| `OUTPUT_UNMONITORED` | Print unmonitored singles that are downloaded. Note that this overrides the `UNMONITOR` option. | `false` |
| Variable | Option | Effect |
| -------------------- | ------- | ------------------------------------------------------------------------------------------------------- |
| `MONITOR` | `false` | Will *just* tell you what singles it finds on albums |
| `MONITOR` | `true` | Will *just* unmonitor said singles and let you know that it unmonitored them |
| `OUTPUT_UNMONITORED` | `false` | Will do nothing (falls back to what you have `MONITOR` set to, if any) |
| `OUTPUT_UNMONITORED` | `true` | Will *just* tell you about **any** single that is unmonitored and downloaded, with a link to delete it. |
## Development
```bash