Skip to content

Commit c34fbea

Browse files
committed
Update README
1 parent 574e17e commit c34fbea

File tree

1 file changed

+27
-43
lines changed

1 file changed

+27
-43
lines changed

README.md

Lines changed: 27 additions & 43 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-
# Sublime Text 3 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+
### Sublime Text 3 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

@@ -25,7 +26,7 @@ Consult the [README](https://github.com/git-time-metric/gtm/blob/master/README.m
2526

2627
In the status bar see your total time spent for in-process work (uncommitted).
2728

28-
![](https://cloud.githubusercontent.com/assets/630550/16570803/e25a7980-4212-11e6-9e7a-a6eff4be118c.png)
29+
![](https://cloud.githubusercontent.com/assets/630550/19831548/21fef6c2-9dd2-11e6-9cf4-7510135eb94a.png)
2930

3031
This can be disabled by setting `gtm_status_bar: false` in gtm.sublime-settings.
3132

@@ -37,51 +38,34 @@ Use the command line to report on time logged for your commits.
3738

3839
Here are some examples of insights GTM can provide you.
3940

40-
**Git commits with time spent**
41-
```
42-
> gtm report -total-only -n 3
41+
<pre>$ gtm report -today -author Schenk
4342

44-
9361c18 Rename packages
45-
Sun Jun 19 09:56:40 2016 -0500 Michael Schenk 34m 30s
43+
7129f00 <b>Remove post processing of status</b>
44+
Fri Sep 09 20:45:03 2016 -0500 <b>gtm-vim-plugin</b> Michael Schenk
4645

47-
341bd77 Vagrant file for testing on Linux
48-
Sun Jun 19 09:43:47 2016 -0500 Michael Schenk 1h 16m 0s
46+
20m 40s 53% [m] plugin/gtm.vim
47+
18m 5s 46% [r] Terminal
48+
15s 1% [m] .gitignore
49+
39m 0s <b>gtm-vim-plugin</b> </pre>
4950

50-
792ba19 Require a 40 char SHA commit hash
51-
Thu Jun 16 22:28:45 2016 -0500 Michael Schenk 1h 1m 0s
52-
```
51+
<pre>$ gtm report -format timeline-hours -last-week -author Schenk
5352

54-
**Git commits with detailed time spent by file**
53+
<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>
54+
------------------------------------------------------------------------
55+
<b>Sat Oct 08</b> | ▃▃▃ | <b>17m 0s</b>
56+
------------------------------------------------------------------------
57+
<b>Sun Oct 09</b> | ▁▁▁ █████████▃▃▃██████▂▂▂ ▂▂▂ | <b>5h 33m 0s</b>
58+
------------------------------------------------------------------------
59+
<b>Tue Oct 11</b> | ▂▂▂ ▂▂▂ | <b>16m 0s</b>
60+
------------------------------------------------------------------------
61+
<b>Fri Oct 14</b> | ▂▂▂ | <b>13m 0s</b>
62+
------------------------------------------------------------------------
63+
<b>Sat Oct 15</b> | ███▇▇▇███▇▇▇███▁▁▁▇▇▇▂▂▂▁▁▁▃▃▃▆▆▆███▇▇▇ | <b>8h 11m 0s</b>
64+
------------------------------------------------------------------------
65+
<b>14h 30m 0s</b> </pre>
5566

56-
```
57-
> gtm report
58-
59-
b2d16c8 Refactor discovering of paths when recording events
60-
Thu Jun 16 11:08:47 2016 -0500 Michael Schenk
61-
62-
30m 18s [m] event/event.go
63-
12m 31s [m] event/manager.go
64-
3m 14s [m] project/project.go
65-
1m 12s [r] .git/COMMIT_EDITMSG
66-
1m 0s [r] .git/index
67-
25s [r] event/manager_test.go
68-
20s [r] metric/manager.go
69-
49m 0s
70-
```
67+
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.
7168

72-
**Timeline of time spent by day**
73-
74-
```
75-
> gtm report -format timeline -n 3
76-
77-
0123456789012345678901234
78-
Fri Jun 24 * 22m 0s
79-
Sat Jun 25 ** 1h 28m 0s
80-
Sun Jun 26 **** 3h 28m 0s
81-
Mon Jun 27 * 4m 0s
82-
Tue Jun 28 ** 1h 36m 0s
83-
6h 58m 0s
84-
```
8569
# Support
8670

8771
To report a bug, please submit an issue on the [GitHub Page](https://github.com/git-time-metric/gtm-sublime3-plugin/issues)

0 commit comments

Comments
 (0)