From e2e56739a843cc0dc26040ea3f77ab2b56c71a81 Mon Sep 17 00:00:00 2001
From: Christian Segundo
Date: Sat, 10 Jun 2023 00:32:38 +0200
Subject: Add readme

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..37431eb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# transmission-hacks
+
+Just a bunch of scripts to automate some tasks in transmission.
+
+# Settings
+
+| Variable Name       	| Default / Description                                                                 	|
+|---------------------	|---------------------------------------------------------------------------------------	|
+| `CRON_LOG_LEVEL`    	|                                               `0` / Tell cron what to log about  jobs 	|
+| `CRON_EXPRESSION`   	|      `*  *  *  *  *` / A cron expression to indicate how often to run **all** scripts 	|
+| `TRANSMISSION_HOST` 	|                                        `localhost` / The host where transmission runs 	|
+| `TRANSMISSION_PORT` 	|                                         `9091` / Port where transmission is listening 	|
+| `DELETE_TAG_0_NAME` 	|                   No default. A transmission tag to match torrents and delete by age. 	|
+| `DELETE_TAG_0_AGE`  	| No default. Time (`1d`, `1w`...etc) string, torrents older than that will be deleted. 	|
-- 
cgit v1.2.3