aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordec05eba <dec05eba@protonmail.com>2019-07-20 20:21:10 +0000
committerdec05eba <dec05eba@protonmail.com>2020-07-06 07:12:34 +0200
commitcdf8d423bc637c12f39e07dc8eb12c1c5d544d7c (patch)
treefc99161233f58780f9e62baf026405bac3146929
parentdbfe833b7c97a37a53ad6d427f6732b54fa6217c (diff)
Update README.md
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index bd5f29c..f0ff576 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,9 @@
# AutoMedia
Automatically track new released of media and download them. Currently works with rss for torrent sites (nyaa.si) and a few manga websites (see plugins directory).
When a download finished, a notification is shown on the screen (if notify-send is installed).
+## Usage
+Run automedia with `sync` option and keep it running to track media. You can then use `add` option to add new media to track.
+Run automedia without any options to see all options.
## TODO
1. Periodically check and remove in_progress files and their directories. This can happen if the computer crashes while adding rss.
2. Automatically remove torrents that have finished seeding, to reduce memory usage and startup time of transmission.