Skip to content

Commit 96a0ab4

Browse files
authored
Merge pull request #5 from kevinmatthes/main
* Improve and mention license in README.md * Fix whitespacing issues in Cargo.toml
2 parents 44decde + 4f809c7 commit 96a0ab4

File tree

2 files changed

+27
-11
lines changed

2 files changed

+27
-11
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ edition = "2021"
77

88
[dependencies]
99
chrono = "*"
10-
getopts = "*"
10+
getopts = "*"

README.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,28 @@
11
# Commit Analyzer
22

3-
This is a simple tool, which takes the output of `git log
4-
--output=outputfile.txt` and analyzes how much time somebody worked on it. E.g.
5-
simply call `commit-analyzer outputfile.txt --author-equals "wert007"` to see
6-
all commits, that fit the criteria and how much time there was put in it.
7-
8-
You can also use the output of `git log --numstat --output=outputfile.txt` and
9-
if you specify an output parameter in commit analyzer (e.g. `commit-analyzer
10-
outputfile.txt --output "commits-and-loc-by-date.csv"`) it will generate an csv
11-
with the date, the number of commits made on that day and the loc changes that
12-
have been made.
3+
## Description
4+
5+
This is a simple tool which takes the output of `git log` and analyzes how much
6+
time somebody worked on the project.
7+
8+
For instance, simply call the following lines to see all commits that fit the
9+
criteria and how much time was spend creating them.
10+
11+
```
12+
git log --output=outputfile.txt
13+
commit-analyzer outputfile.txt --author-equals "wert007"
14+
```
15+
16+
You can also use the output of `git log --numstat` and give `commit-analyzer`
17+
an output file such that it will generate a CSV with the date, the number of
18+
commits made on that day and the loc changes that have been made.
19+
20+
```
21+
git log --numstat --output=outputfile.txt
22+
commit-analyzer outputfile.txt --output "commits-and-loc-by-date.csv"
23+
```
24+
25+
## License
26+
27+
This project's license is **MIT**. The license can be found `LICENSE` in the
28+
main directory of this repository.

0 commit comments

Comments
 (0)