summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKimmo Brunfeldt <kimmobrunfeldt@gmail.com>2014-07-28 01:48:18 +0300
committerKimmo Brunfeldt <kimmobrunfeldt@gmail.com>2014-07-28 01:48:18 +0300
commitc49aca2dc32ca306d14c34ed98160926a12f9893 (patch)
tree594417b62334ed1d070874de5c545bae0d61b72a
parent16946487b2b56f8d303ad45ad1eff7700c9c813b (diff)
downloadgit-hours-c49aca2dc32ca306d14c34ed98160926a12f9893.zip
git-hours-c49aca2dc32ca306d14c34ed98160926a12f9893.tar.gz
git-hours-c49aca2dc32ca306d14c34ed98160926a12f9893.tar.bz2
Put texts under images and add begin step in algorithm
-rw-r--r--README.md25
-rw-r--r--docs/step0.pngbin7633 -> 3849 bytes
-rw-r--r--docs/step1.pngbin8006 -> 10979 bytes
-rw-r--r--docs/step2.pngbin8653 -> 8006 bytes
-rw-r--r--docs/step3.pngbin3190 -> 8653 bytes
-rw-r--r--docs/step4.pngbin0 -> 3190 bytes
6 files changed, 17 insertions, 8 deletions
diff --git a/README.md b/README.md
index f117900..4fd9dd0 100644
--- a/README.md
+++ b/README.md
@@ -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>
+
![](docs/step0.png)
-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>
![](docs/step1.png)
-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>
![](docs/step2.png)
-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>
![](docs/step3.png)
-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>
+
+![](docs/step4.png)
+
+*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
index a898472..663c53b 100644
--- a/docs/step0.png
+++ b/docs/step0.png
Binary files differ
diff --git a/docs/step1.png b/docs/step1.png
index 3c5d3ab..18206cb 100644
--- a/docs/step1.png
+++ b/docs/step1.png
Binary files differ
diff --git a/docs/step2.png b/docs/step2.png
index b12733b..3c5d3ab 100644
--- a/docs/step2.png
+++ b/docs/step2.png
Binary files differ
diff --git a/docs/step3.png b/docs/step3.png
index 0cd41e5..b12733b 100644
--- a/docs/step3.png
+++ b/docs/step3.png
Binary files differ
diff --git a/docs/step4.png b/docs/step4.png
new file mode 100644
index 0000000..0cd41e5
--- /dev/null
+++ b/docs/step4.png
Binary files differ