Skip to content

Commit 6bf3302

Browse files
committed
Add initial docs and preview
1 parent 138d8e1 commit 6bf3302

File tree

3 files changed

+46
-8
lines changed

3 files changed

+46
-8
lines changed

documentation.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# gtt taskbar documentation
2+
3+
Coming soon!
4+
5+
## contents
6+
7+
* [support further development 🍺](#support-further-development)
8+
* [license](#license)
9+
10+
## support further development
11+
12+
gtt is an open source project, developed and maintained completely in my free time.
13+
14+
If you enjoy using gtt you can support the project by [contributing](#) to the code base,
15+
sharing it to your colleagues and co-workers or monetarily by [donating via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TXL5G4BDN8JP6).
16+
Every type of support is helpful and thank you very much if you consider supporting the project
17+
or already have done so. 💜
18+
19+
## license
20+
21+
GPL v2

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
"browser-support"
6262
],
6363
"grade": "stable",
64-
"desktopTemplate": "./.desktop"
64+
"desktopTemplate": ".desktop"
6565
},
6666
"electronWinstallerConfig": {
6767
"name": "gtt-taskbar",

readme.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,27 @@
1-
# ![gtt](https://raw.githubusercontent.com/kriskbx/gitlab-time-tracker-taskbar/master/src/icons/png/64x64.png) gtt taskbar
1+
![gtt](https://raw.githubusercontent.com/kriskbx/gitlab-time-tracker-taskbar/master/resources/images/preview/preview.png)
22

3-
[![Github All Releases](https://img.shields.io/github/downloads/kriskbx/gitlab-time-tracker-taskbar/total.svg?style=flat-square)](https://github.com/kriskbx/gitlab-time-tracker-taskbar/releases)
4-
[![GitHub (pre-)release](https://img.shields.io/github/release/kriskbx/gitlab-time-tracker-taskbar/all.svg?style=flat-square)](https://github.com/kriskbx/gitlab-time-tracker-taskbar/releases)
5-
[![Travis (Linux, Mac OS)](https://img.shields.io/travis/kriskbx/gitlab-time-tracker-taskbar/production.svg?style=flat-square)](https://travis-ci.org/kriskbx/gitlab-time-tracker-taskbar)
6-
[![AppVeyor (Windows)](https://img.shields.io/appveyor/ci/kriskbx/gitlab-time-tracker-taskbar/production.svg?style=flat-square)](https://ci.appveyor.com/project/kriskbx/gitlab-time-tracker-taskbar)
7-
[![GitHub](https://img.shields.io/github/license/kriskbx/gitlab-time-tracker-taskbar.svg?style=flat-square)](https://github.com/kriskbx/gitlab-time-tracker-taskbar/blob/master/LICENSE)
3+
<p align="center">
4+
<a href="https://github.com/kriskbx/gitlab-time-tracker-taskbar/releases"><img src="https://img.shields.io/github/downloads/kriskbx/gitlab-time-tracker-taskbar/total.svg?style=flat-square"></a>
5+
<a href="https://github.com/kriskbx/gitlab-time-tracker-taskbar/releases"><img src="https://img.shields.io/github/release/kriskbx/gitlab-time-tracker-taskbar/all.svg?style=flat-square"></a>
6+
<a href="https://travis-ci.org/kriskbx/gitlab-time-tracker-taskbar"><img src="https://img.shields.io/travis/kriskbx/gitlab-time-tracker-taskbar/production.svg?style=flat-square"></a>
7+
<a href="https://ci.appveyor.com/project/kriskbx/gitlab-time-tracker-taskbar"><img src="https://img.shields.io/appveyor/ci/kriskbx/gitlab-time-tracker-taskbar/production.svg?style=flat-square"></a>
8+
<a href="https://github.com/kriskbx/gitlab-time-tracker-taskbar/blob/master/LICENSE"><img src="https://img.shields.io/github/license/kriskbx/gitlab-time-tracker-taskbar.svg?style=flat-square"></a>
9+
</p>
810

9-
> An open source crossplatform menubar/taskbar application for GitLab's time tracking feature based on the [gtt command line interface](https://github.com/kriskbx/gitlab-time-tracker).
11+
## introduction
1012

13+
gtt taskbar is an open source crossplatform (Linux, Mac OS, Windows) menubar/taskbar application for GitLab's time tracking feature based on the [gtt command line interface](https://github.com/kriskbx/gitlab-time-tracker).
14+
15+
![Linux, Mac OS, Windows](https://raw.githubusercontent.com/kriskbx/gitlab-time-tracker-taskbar/master/resources/images/preview/os.png)
16+
17+
## documentation
18+
19+
How to install and use gtt taskbar? You can find the documentation [here](https://github.com/kriskbx/gitlab-time-tracker-taskbar/blob/master/documentation.md).
20+
21+
## support further development
22+
23+
Please support the development of this free software by [donating or sharing](https://github.com/kriskbx/gitlab-time-tracker-taskbar/blob/master/documentation.md#support-further-development)!
24+
25+
## license
26+
27+
gtt is open-source software licensed under the [GPL V2 license](https://github.com/kriskbx/gitlab-time-tracker-taskbar/blob/master/LICENSE).

0 commit comments

Comments
 (0)