Skip to content

Commit 7d19ce3

Browse files
committed
Update README.md with information on improved console output and 'commit_nr'
1 parent 7a40b52 commit 7d19ce3

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,26 @@
2222

2323
**Gitlogg** is not a very complex application, but I still made an effort to provide some feedback on what is happening under the hood. Below are some screenshots of dialogs one can expect to see while executing it:
2424

25-
![Success!](https://raw.githubusercontent.com/dreamyguy/gitlogg/master/docs/success.png "Success messages as on release v0.1.3")
26-
> **Success!** `JSON` parsed, based on **7** different repositories with a total of **7375** commits.
27-
2825
![Error 001](https://raw.githubusercontent.com/dreamyguy/gitlogg/master/docs/error-001.png "'Error 001' message as on release v0.1.3")
2926
> **Øh nøes!** The path to the folder containing all repositories *does not exist!*
3027
3128
![Error 002](https://raw.githubusercontent.com/dreamyguy/gitlogg/master/docs/error-002.png "'Error 002' message as on release v0.1.3")
3229
> **Øh nøes!** The path to the folder containing all repositories *exists, but is empty!*
3330
34-
## Requirements
31+
![Success!](https://raw.githubusercontent.com/dreamyguy/gitlogg/master/docs/success.png "Success messages as on release v0.1.3")
32+
> **Success!** `JSON` parsed, based on **9** different repositories with a total of **25,537** commits.
33+
34+
Note that I've included two huge repos (react & react-native, that have 7,813 & 10,065 commits respectively at the time of this writting) for the sake of demonstration. The resulting parsed `JSON` file has 715,040 lines. All that done in less than 25 seconds.
35+
36+
*I have successfully compiled **`470`** repositories at once* (all repos under the organization I work for). Then I got these specs:
37+
38+
* `gitlogg.tmp` generated in `154s` (`~2.57mins`)
39+
* `JSON` output parsed in `2792ms`
40+
* `JSON` file size: `121,5MB`
41+
* Commits processed: `118,117`
42+
* Parsed `JSON` file, lines: `3,307,280`
43+
44+
## Requirementss
3545

3646
[NodeJS][2] and [BabelJS][3].
3747

@@ -47,6 +57,7 @@ The output will look like this (first commit for **Font Awesome**):
4757
"commits": [
4858
{
4959
"repository": "Font-Awesome",
60+
"commit_nr": 1
5061
"commit_hash": "7ed221e28df1745a20009329033ac690ef000575",
5162
"author_name": "Dave Gandy",
5263
"author_email": "[email protected]",
@@ -84,6 +95,7 @@ The output will look like this (first commit for **Font Awesome**):
8495
Note that many `git log` fields were not printed here, but that's only because I've commented out some of them in the **gitlogg-parse-json.js** script. All the fields below are available. Fields marked with a `*` are either non-standard or not available as placeholders on `--pretty=format:<string>`:
8596

8697
* repository
98+
* commit_nr
8799
commit_hash
88100
commit_hash_abbreviated
89101
tree_hash

docs/success.png

31.3 KB
Loading

0 commit comments

Comments
 (0)