summaryrefslogtreecommitdiff
path: root/README.mdown
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.mdown14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.mdown b/README.mdown
new file mode 100644
index 0000000..88c2356
--- /dev/null
+++ b/README.mdown
@@ -0,0 +1,14 @@
+# dupekill -- deletes duplicates of existing data
+
+dupekill is a simple dupe finder (and deleter). It comes with a few nifty flags:
+
+* `-d | --dry`: Provides a preview of what you will do if the `-d` flag is
+ removed.
+* `-r | --recursive`: Descends into all subdirectories below the starting
+ point.
+* `-v | --verbose`: Provide more detail.
+
+# Roadmap
+
+* Create options for file preference, e.g. "if two files are the same, prefer
+ the older one".