From 4130398fbf7ae0bd7aae1bbe5e487f06e90f7f58 Mon Sep 17 00:00:00 2001
From: Niko Medvesky <nikomedvesky@gmail.com>
Date: Mon, 3 Feb 2025 18:14:36 -0600
Subject: [PATCH] Added README.md

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..072db91
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Duplicated
+**Duplicated** finds files with the same contents on your computer.
+
+Hashes all files in filter and compares to see if there are any duplicates.
+
+# Build from Source
+## Requirements
+- Minimum supported `rust`/`cargo` version: `1.78`
+
+## cargo
+`$ cargo install --git https://github.com/NMedvesky/duplicated`
+
+# Usage
+Check all files in currect directory
+`duplicated .`
+
+Check all files larger than 5 megabytes and smaller than 1 gigabyte.
+`duplicated --min_size 5M --max_size 1G`
+
+Same as previous example but another way to write it.
+`duplicated -s 5m -m 1g`