about summary refs log tree commit diff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index 5345195..734e81f 100644
--- a/readme.md
+++ b/readme.md
@@ -1,8 +1,15 @@
-`whenwasit path`  
+```
+Usage: whenwasit [options] PATH
+```
+
 little thing meant to be called in a git-hook as to keep track of
 file creation and modification dates, which are important to me.
 dumps csv output on stdout, errors abort with a panic.
 
+You can use the flag `--ignore` to stop it from descending into
+directories. The flag takes a path to a file that contains a list
+of directory to ignore, relative to the path given to whenwasit.
+
 **CSV Output Defintion:**  
 data is output on `stdout` in a CSV format. because there are
 varying ways to make a CSV, it's described in detail below.