Skip to content
This repository was archived by the owner on May 22, 2025. It is now read-only.

Commit e1e36ed

Browse files
committed
Unsuck docs #1
1 parent 68d5975 commit e1e36ed

File tree

3 files changed

+31
-33
lines changed

3 files changed

+31
-33
lines changed

preview.gif

-3.93 MB
Binary file not shown.

readme.md

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
1-
# gtt
2-
3-
[![npm](https://img.shields.io/npm/dt/gitlab-time-tracker.svg?style=flat-square)](https://www.npmjs.com/package/gitlab-time-tracker)
4-
[![npm](https://img.shields.io/npm/v/gitlab-time-tracker.svg?style=flat-square)](https://www.npmjs.com/package/gitlab-time-tracker)
1+
# gtt [![npm](https://img.shields.io/npm/dt/gitlab-time-tracker.svg?style=flat-square)](https://www.npmjs.com/package/gitlab-time-tracker) [![npm](https://img.shields.io/npm/v/gitlab-time-tracker.svg?style=flat-square)](https://www.npmjs.com/package/gitlab-time-tracker)
52

63
> A command line interface that makes working with GitLabs time tracking feature more enjoyable.
74
85
gtt monitors the time you spent on an issue or merge request locally and syncs it to GitLab.
96
It also allows you to create time tracking reports in various formats from time tracking data
107
stored on GitLab.
118

12-
![preview](https://raw.githubusercontent.com/kriskbx/gitlab-time-tracker/master/preview.gif)
13-
149
## requirements
1510

1611
* [node.js](https://nodejs.org/en/download) version > 6
@@ -43,37 +38,12 @@ url: https://gitlab.com/api/v4/
4338
token: 01234567891011
4439
```
4540

46-
#### upgrading from 0.*
47-
48-
I built gtt originally in PHP because I'm a PHP dev and I chose the language I'm most familiar
49-
with to create a quick and dirty prototype. After some consideration I rebuilt everything from
50-
scratch for node.js. Follow these steps to upgrade:
51-
52-
```
53-
# 1. remove the old version entirely
54-
composer global remove kriskbx/gitlab-time-tracker
55-
56-
# 2. install the new version
57-
# using yarn
58-
yarn global add gitlab-time-tracker --prefix /usr/local
59-
60-
# using npm
61-
npm install -g gitlab-time-tracker
62-
63-
# 3. edit your configuration and update the date format
64-
# format options: http://momentjs.com/docs/#/displaying/format/
65-
gtt edit
66-
67-
# 4. the columns option is now split into 3 options for different parts of
68-
# the report: issueColumns, mergeRequestColumns and recordColumns
69-
# there's also a userColumns option that adds a column for each user
70-
# with total time spent. please update your config accordingly
71-
```
72-
7341
## commands
7442

7543
#### time tracking
7644

45+
46+
7747
Time tracking enables you to track and monitor your time locally. When you're done,
7848
you can sync time records to GitLab and create "time spent comments" automatically.
7949

upgrade.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# gtt
2+
3+
### upgrading from 0.*
4+
5+
I built gtt originally in PHP because I'm a PHP dev and I chose the language I'm most familiar
6+
with to create a quick and dirty prototype. After some consideration I rebuilt everything from
7+
scratch for node.js. Follow these steps to upgrade:
8+
9+
```
10+
# 1. remove the old version entirely
11+
composer global remove kriskbx/gitlab-time-tracker
12+
13+
# 2. install the new version
14+
# using yarn
15+
yarn global add gitlab-time-tracker --prefix /usr/local
16+
17+
# using npm
18+
npm install -g gitlab-time-tracker
19+
20+
# 3. edit your configuration and update the date format
21+
# format options: http://momentjs.com/docs/#/displaying/format/
22+
gtt edit
23+
24+
# 4. the columns option is now split into 3 options for different parts of
25+
# the report: issueColumns, mergeRequestColumns and recordColumns
26+
# there's also a userColumns option that adds a column for each user
27+
# with total time spent. please update your config accordingly
28+
```

0 commit comments

Comments
 (0)