about summary refs log tree commit diff
path: root/readme.md
diff options
context:
space:
mode:
authorgennyble <gen@nyble.dev>2023-08-24 21:49:51 -0500
committergennyble <gen@nyble.dev>2023-08-24 21:49:51 -0500
commita65355c1476d4815f0b28959fd2cd2f160dc4374 (patch)
tree8661b7ff3d8ba6053a11ed12230f37524850eefe /readme.md
parent544aae00aa8d589a2b2817373611d21aa70eec0e (diff)
downloadwhenwasit-a65355c1476d4815f0b28959fd2cd2f160dc4374.tar.gz
whenwasit-a65355c1476d4815f0b28959fd2cd2f160dc4374.zip
add pre-commit example
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index 734e81f..b49a9eb 100644
--- a/readme.md
+++ b/readme.md
@@ -9,6 +9,11 @@ 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.
+See [.whenwasit-ignore](/.whenwasit-ignore) as an example.
+
+For an example on how you might use whenwasit as a git hook, see
+[pre-commit](/pre-commit). It runs whenwasit before commit,
+makes the file [.whenwasit](/.whenwasit), and adds it to the commit.
 
 **CSV Output Defintion:**  
 data is output on `stdout` in a CSV format. because there are