diff options
| author | aetherised | 2021-11-09 15:22:42 -0500 |
|---|---|---|
| committer | aetherised | 2021-11-09 15:22:42 -0500 |
| commit | 4055bcc0bb67caf6b036278934cdcaaebd70fbd1 (patch) | |
| tree | 09b5408a59e2b5f9e948bac79c3c878586913676 | |
| parent | 57b93f17b770e13c50ed99c5a5137e3242278ee7 (diff) | |
| download | aur-4055bcc0bb67caf6b036278934cdcaaebd70fbd1.tar.gz | |
update readme to reflect notification feature and torrent file handling
| -rw-r--r-- | README.md | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/README.md b/README.md index fe8c2f94d04f..06d25b8c200e 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,24 @@ -**A simple tool to open magnet links** using a remote +**A simple tool to open torrents and magnet links** using a remote [Transmission](https://github.com/transmission/transmission) daemon. Includes a `.desktop` file for use with `xdg-open`. The remote server address is configurable on a system-wide and per-user basis. -Requires that `transmission-remote` be available on the system. Includes -PKGBUILD for installation on Arch. Under Arch, `transmission-remote` is found in -the `transmission-cli` package. +Requires that `transmission-remote` be available on the system. Desktop +notifications require `notify-send`. Includes PKGBUILD for installation on Arch. +Under Arch, `transmission-remote` is found in the `transmission-cli` package. # USAGE -**`addmag LINK`** where `LINK` is a magnet link or path to a torrent file +**`addmag LINK`** where `LINK` is a magnet link or torrent file + +# NOTIFICATIONS + +Specify the `-n` flag to generate desktop notifications, ie.: + + `addmag -n LINK` + +A notification will be created on success or failure. Failure notifications will +be marked critical. # CONFIGURATION |