From 922678b223bc6eb0b9c586d45ae4fcab02870178 Mon Sep 17 00:00:00 2001 From: "Wyatt J. Miller" Date: Tue, 27 Dec 2022 21:50:12 -0600 Subject: [PATCH] update readme --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ac84b1..4feba39 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,14 @@ To get a commit report to a PDF file filtered by the `devel` branch: drillsergeant -o pdf -b devel ``` +To get a tally based on a directory: + +```bash +drillsergeant -f /home/user/drillsergeant +``` + +This also works on enviroment variables too! + Got too many contributors to fit onto your terminal? Run this by installing [bat](https://github.com/sharkdp/bat): ```bash @@ -143,7 +151,7 @@ Then, you can find the binary in the `publish/` directory. You can move this exe ## Known Issues -- A user must be in the root of a git project in order for this program to run. +- A user must be in the root of a git project in order for this program to run (unless the user runs the `-f` flag when invoking `drillsergeant`). ## Next Steps/Contributing