Add README

1 files changed, 14 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..85c817c
--- /dev/null
+++ b/README
@@ -0,0 +1,14 @@
+rencon is a simple, safe tool able to rename files based on their content.
+
+Example usage:
+    rencon -m 'r_${hash}.${ext}' *.jpg
+
+It will rename all .jpg files with a hash based on their content, and add "r_"
+to distinguish them.
+
+The default mask is ${hash}.${ext}. The hash used is SHA1.
+
+For more information, run rencon -h.
+
+It does not erase existing files.
+While it can be used in that way it does not aim to do file deduplication.