update readme, update cargo.toml

This commit is contained in:
SeanOMik 2023-05-29 20:57:22 -04:00
parent 48080045b7
commit 816329ed96
Signed by: SeanOMik
GPG Key ID: 568F326C7EB33ACB
2 changed files with 17 additions and 1 deletions

View File

@ -1,6 +1,6 @@
[package]
name = "torrent-cleanup"
description = "tiny tool for cleaning up the torrent download directory"
description = "Tiny CLI that deletes files in a torrent download directory that are not associated with a torrent in another directory."
version = "0.1.0"
edition = "2021"

16
README.md Normal file
View File

@ -0,0 +1,16 @@
# Torrent Cleanup
Simple CLI tool I wrote in 30ish minutes to delete files in a torrent download directory that are not associated with a torrent.
## Usage:
```
Tiny CLI that deletes files in a torrent download directory that are not associated with a torrent in another directory.
Usage: torrent-cleanup [OPTIONS] --torrents <TORRENTS> --path <PATH>
Options:
-t, --torrents <TORRENTS> Path of torrent files
-p, --path <PATH> Path of downloaded files
-c, --change Whether or not to make changes (set to true when you actually want it to run)
-h, --help Print help
-V, --version Print version
```