From 816329ed96fbf70a572d023421c842470e76dba7 Mon Sep 17 00:00:00 2001
From: SeanOMik <seanomik@gmail.com>
Date: Mon, 29 May 2023 20:57:22 -0400
Subject: [PATCH] update readme, update cargo.toml

---
 Cargo.toml |  2 +-
 README.md  | 16 ++++++++++++++++
 2 files changed, 17 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/Cargo.toml b/Cargo.toml
index c140970..f2dc0b0 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -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"
 
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2523ff3
--- /dev/null
+++ b/README.md
@@ -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
+```
\ No newline at end of file