diff options
author | gennyble <gen@nyble.dev> | 2023-08-25 22:39:02 -0500 |
---|---|---|
committer | gennyble <gen@nyble.dev> | 2023-08-25 22:39:02 -0500 |
commit | 5ba8d61dfa0d36f4d63f5eb6a6a466d1a6e8a6dd (patch) | |
tree | 3aa66f87e1b4d11449fbdc3408da643b96b9f91e /readme.md | |
parent | bf50edc9462d5144d989124b5317bbe2481f12e1 (diff) | |
download | whenwasit-5ba8d61dfa0d36f4d63f5eb6a6a466d1a6e8a6dd.tar.gz whenwasit-5ba8d61dfa0d36f4d63f5eb6a6a466d1a6e8a6dd.zip |
docs cleanup
Diffstat (limited to 'readme.md')
-rw-r--r-- | readme.md | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/readme.md b/readme.md index 4a857b1..65bd3bc 100644 --- a/readme.md +++ b/readme.md @@ -7,18 +7,19 @@ file creation and modification dates, which are important to me. dumps csv output on stdout, errors abort with a panic *(this will be fixed later)*. -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. +Use the `--format` flag *(`-f`)* to switch between outputting +`json` or `csv`. the default is `csv`. + +The flag `--ignore` can be used to ignore paths relative to +the one whenwasit was given. 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. +makes the file [times.csv](/times.csv), and adds it to the commit. **CSV Output Definition:** -data is output on `stdout` in a CSV format. because there are -varying ways to make a CSV, it's described in detail below. +because there are varying ways to make a CSV, it's described in detail below. - there is no header; the first row is data - the data rows are in the format `path,btime,mtime,atime` |