add readme.md

syrflover · Jul 6, 2024 · 23fb651 · 23fb651
1 parent 44f682e
commit 23fb651
Showing 1 changed file with 30 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -0,0 +1,30 @@
+# transmission-rss
+
+## installation and example usage
+
+### from source
+
+```sh
+git clone git@github.com:syrflover/transmission-rss.git
+cargo install --path ./transmission-rss
+
+export TRANSMISSION_URL=http://localhost:9091/transmission/rpc
+export CHANNELS_CONFIG_URL=https://raw.githubusercontent.com/syrflover/syrflover/master/transmission-rss-channels.yaml
+
+# run for one time
+transmission-rss
+```
+
+### from dockerhub
+
+```sh
+# run for one time
+docker run -t \
+    -e TRANSMISSION_URL=http://localhost:9091/transmission/rpc \
+    -e CHANNELS_CONFIG_URL=https://raw.githubusercontent.com/syrflover/syrflover/master/transmission-rss-channels.yaml \
+    syrlee/transmission-rss:0.1.0
+```
+
+## configuration
+
+[example](https://github.com/syrflover/syrflover/blob/master/transmission-rss-channels.yaml)