diff options
| -rw-r--r-- | README.md | 25 | ||||
| -rw-r--r-- | docs/step0.png | bin | 7633 -> 3849 bytes | |||
| -rw-r--r-- | docs/step1.png | bin | 8006 -> 10979 bytes | |||
| -rw-r--r-- | docs/step2.png | bin | 8653 -> 8006 bytes | |||
| -rw-r--r-- | docs/step3.png | bin | 3190 -> 8653 bytes | |||
| -rw-r--r-- | docs/step4.png | bin | 0 -> 3190 bytes |
6 files changed, 17 insertions, 8 deletions
@@ -6,7 +6,7 @@ Estimate time spent on a git repository. **Example** -```json +```javascript ➜ git-hours git:(master) githours { "total": { @@ -20,30 +20,37 @@ Estimate time spent on a git repository. The algorithm for estimating hours is quite simple. +<br> +  -Go through all commits and compare the difference between -them in time. +*Go through all commits and compare the difference between +them in time.* <br>  -If the difference is smaller or equal then a given threshold, group the commits -to a same coding session. +*If the difference is smaller or equal then a given threshold, group the commits +to a same coding session.* <br>  -If the difference is bigger than a given threshold, the coding session is finished. -To compensate the first commit whose work is unknown, we add extra hours to the coding session. +*If the difference is bigger than a given threshold, the coding session is finished.* <br>  -This is continued until we have determined all coding sessions. +*To compensate the first commit whose work is unknown, we add extra hours to the coding session.* + +<br> + + + +*Continue until we have determined all coding sessions.* <br> @@ -52,6 +59,8 @@ This is continued until we have determined all coding sessions. npm install -g nodegit npm install -g git-hours +Nodegit library is a bit unstable and might crash randomly. + ## Usage In root of a git repository run: diff --git a/docs/step0.png b/docs/step0.png Binary files differindex a898472..663c53b 100644 --- a/docs/step0.png +++ b/docs/step0.png diff --git a/docs/step1.png b/docs/step1.png Binary files differindex 3c5d3ab..18206cb 100644 --- a/docs/step1.png +++ b/docs/step1.png diff --git a/docs/step2.png b/docs/step2.png Binary files differindex b12733b..3c5d3ab 100644 --- a/docs/step2.png +++ b/docs/step2.png diff --git a/docs/step3.png b/docs/step3.png Binary files differindex 0cd41e5..b12733b 100644 --- a/docs/step3.png +++ b/docs/step3.png diff --git a/docs/step4.png b/docs/step4.png Binary files differnew file mode 100644 index 0000000..0cd41e5 --- /dev/null +++ b/docs/step4.png |
