update readme
This commit is contained in:
parent
e156eef14c
commit
922678b223
10
README.md
10
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
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user