Skip to content

Commit 5c498b3

Browse files
committed
Update README
1 parent 4be2b2c commit 5c498b3

File tree

1 file changed

+31
-46
lines changed

1 file changed

+31
-46
lines changed

README.md

Lines changed: 31 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
![GTM Logo](https://raw.githubusercontent.com/git-time-metric/gtm-atom-plugin/master/lib/GTMLogo-128.png)
2-
# Vim Git Time Metrics (GTM) plug-in
3-
### Simple, seamless, lightweight time tracking for all your git projects
1+
<div align="center"><img src="https://cloud.githubusercontent.com/assets/630550/19619834/43c460dc-9835-11e6-8652-1c8fff91cf02.png" alt="GTM Logo" height="115" width="275"></div>
2+
# <div align="center">Git Time Metric</div>
3+
### Vim Git Time Metrics (GTM) plug-in
4+
#### Simple, seamless, lightweight time tracking for all your git projects
45

56
Git Time Metrics (GTM) is a tool to automatically track time spent reading and working on code that you store in a Git repository. By installing GTM and using supported plug-ins for your favorite editors, you can immediately realize better insight into how you are spending your time and on what files.
67

@@ -62,49 +63,33 @@ Use the command line to report on time logged for your commits.
6263

6364
Here are some examples of insights GTM can provide you.
6465

65-
**Git commits with time spent**
66-
```
67-
> gtm report -total-only -n 3
68-
69-
9361c18 Rename packages
70-
Sun Jun 19 09:56:40 2016 -0500 Michael Schenk 34m 30s
71-
72-
341bd77 Vagrant file for testing on Linux
73-
Sun Jun 19 09:43:47 2016 -0500 Michael Schenk 1h 16m 0s
74-
75-
792ba19 Require a 40 char SHA commit hash
76-
Thu Jun 16 22:28:45 2016 -0500 Michael Schenk 1h 1m 0s
77-
```
78-
79-
**Git commits with detailed time spent by file**
80-
```
81-
> gtm report
82-
83-
b2d16c8 Refactor discovering of paths when recording events
84-
Thu Jun 16 11:08:47 2016 -0500 Michael Schenk
85-
86-
30m 18s [m] event/event.go
87-
12m 31s [m] event/manager.go
88-
3m 14s [m] project/project.go
89-
1m 12s [r] .git/COMMIT_EDITMSG
90-
1m 0s [r] .git/index
91-
25s [r] event/manager_test.go
92-
20s [r] metric/manager.go
93-
49m 0s
94-
```
95-
96-
**Timeline of time spent by day**
97-
```
98-
> gtm report --format timeline -n 3
99-
100-
0123456789012345678901234
101-
Fri Jun 24 * 22m 0s
102-
Sat Jun 25 ** 1h 28m 0s
103-
Sun Jun 26 **** 3h 28m 0s
104-
Mon Jun 27 * 4m 0s
105-
Tue Jun 28 ** 1h 36m 0s
106-
6h 58m 0s
107-
```
66+
<pre>$ gtm report -today -author Schenk
67+
68+
7129f00 <b>Remove post processing of status</b>
69+
Fri Sep 09 20:45:03 2016 -0500 <b>gtm-vim-plugin</b> Michael Schenk
70+
71+
20m 40s 53% [m] plugin/gtm.vim
72+
18m 5s 46% [r] Terminal
73+
15s 1% [m] .gitignore
74+
39m 0s <b>gtm-vim-plugin</b> </pre>
75+
76+
<pre>$ gtm report -format timeline-hours -last-week -author Schenk
77+
78+
<b>00.01.02.03.04.05.06.07.08.09.10.11.12.01.02.03.04.05.06.07.08.09.10.11.</b>
79+
------------------------------------------------------------------------
80+
<b>Sat Oct 08</b> | ▃▃▃ | <b>17m 0s</b>
81+
------------------------------------------------------------------------
82+
<b>Sun Oct 09</b> | ▁▁▁ █████████▃▃▃██████▂▂▂ ▂▂▂ | <b>5h 33m 0s</b>
83+
------------------------------------------------------------------------
84+
<b>Tue Oct 11</b> | ▂▂▂ ▂▂▂ | <b>16m 0s</b>
85+
------------------------------------------------------------------------
86+
<b>Fri Oct 14</b> | ▂▂▂ | <b>13m 0s</b>
87+
------------------------------------------------------------------------
88+
<b>Sat Oct 15</b> | ███▇▇▇███▇▇▇███▁▁▁▇▇▇▂▂▂▁▁▁▃▃▃▆▆▆███▇▇▇ | <b>8h 11m 0s</b>
89+
------------------------------------------------------------------------
90+
<b>14h 30m 0s</b> </pre>
91+
92+
GTM is automatic, seamless and lightweight. There is no need to remember to start and stop timers. It runs on occasion to capture activity triggered by your editor. The time metrics are stored locally with the git repository as [Git notes](https://git-scm.com/docs/git-notes) and can be pushed to the remote repository.
10893

10994
# Support
11095

0 commit comments

Comments
 (0)