Skip to content

Commit

Permalink
update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
knbr13 committed Jun 5, 2024
1 parent 65212da commit 388eee8
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ By default, the tool displays commits from the last 6 months, but you can config
> gitcs -since "2023-10-24" -until "2024-01-15"
```

By default, the tool displays the commits made in your working directory (the directory where you at while running the tool), you can use the -path flag to specify the path to scan for commits in.
```bash
> gitcs -path "/home/username/dev"
```

- If no global Git email is set on your machine, then you have to specify it using the `-email` flag.
- The since and until flags don't need to be specified together.

Expand Down

0 comments on commit 388eee8

Please sign in to comment.