aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 18 insertions, 3 deletions
diff --git a/README.md b/README.md
index 2df10c6..b01c6bb 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
-# transmission-hacks
+# [transmission-hacks](https://git.segundo.io/docker/transmission-hacks/tree/)
-Just a bunch of scripts to automate some tasks in transmission.
+> Transmission hacks to automate removals, tagging and more
-# Settings
+## Settings
| Variable Name | Default / Description |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
@@ -15,3 +15,18 @@ Just a bunch of scripts to automate some tasks in transmission.
| `DELETE_TAG_0_AGE` | No default. Time (`1d`, `1w`...etc) string, torrents older than that will be deleted. |
| `DELETE_UNLINKED_1_NAME` | No default. A transmission tag to match torrents and delete if greater than age and has no links pointing to it. |
| `DELETE_UNLINKED_1_AGE` | No default. No default. Time (`1d`, `1w`...etc) string, torrents older than what will be deleted if there are no links pointing to it. |
+
+### Example
+
+```sh
+docker run --rm \
+ -v /transmission/downloads/dir:/downloads:ro \
+ -e TRANSMISSION_HOST=transmission \
+ -e DELETE_TAG_0_NAME=some-tag \
+ -e DELETE_TAG_0_AGE=12d \
+ -e DELETE_TAG_1_NAME=none \
+ -e DELETE_TAG_1_AGE=12d \
+ -e DELETE_UNLINKED_0_NAME=another-tag \
+ -e DELETE_UNLINKED_0_AGE=1w \
+ chn2guevara/transmission-hacks:latest
+```