Add README.md

This commit is contained in:
Jeffrey Serio 2023-10-02 10:31:23 -05:00
parent d6bb7478f3
commit 23db6bc102
2 changed files with 35 additions and 1 deletions

34
README.md Normal file
View File

@ -0,0 +1,34 @@
# go-torrent-helper
This is a helper program to add and remove torrents from a transmission-daemon instance.
To use, make sure `TRANSMISSION_RPC_URL` is exported in the shell:
``` bash
export TRANSMISSION_RPC_URL=10.0.0.42
```
Install with Go:
``` bash
go install git.sr.ht/~hyperreal/go-torrent-helper@latest
```
## Usage
``` bash
# Add Fedora torrents
go-torrent-helper add -distro fedora -relver 38
# Remove NixOS torrents
go-torrent-helper remove -distro nixos
# Add Rocky Linux torrents
go-torrent-helper add -distro rocky -relver 9.2
# Remove older Rocky Linux torrents
go-torrent-helper remove -distro rocky -relver 8.1
# If not -relver flag is supplied for the remove subcommand, remove all torrents for given distro
go-torrent-helper remove -distro debian
```

View File

@ -9,7 +9,7 @@ export TRANSMISSION_RPC_URL=10.0.0.42
Install with Go: Install with Go:
#+begin_src shell #+begin_src shell
go install tildegit.org/hyperreal/go-torrent-helper@latest go install git.sr.ht/~hyperreal/go-torrent-helper@latest
#+end_src #+end_src
Example usage: Example usage: