Skip to content

Commit cdb0710

Browse files
committed
📝 Update README and help.
1 parent d88b3e6 commit cdb0710

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@
55

66
A terminal based client for Clockify time tracker
77

8-
[![goclockify](https://snapcraft.io//goclockify/badge.svg)](https://snapcraft.io/goclockify)
98
[![GitHub release](https://img.shields.io/github/release/ABGEO/goclockify.svg)](https://github.com/ABGEO/goclockify/releases)
109
[![GitHub license](https://img.shields.io/github/license/ABGEO/goclockify.svg)](https://github.com/ABGEO/goclockify/blob/1.x/LICENSE)
10+
![AUR version](https://img.shields.io/aur/version/goclockify)
11+
[![goclockify](https://snapcraft.io//goclockify/badge.svg)](https://snapcraft.io/goclockify)
1112

1213
<img src="./assets/demo.gif" />
1314
</div>
@@ -109,7 +110,9 @@ When everything is set up correctly you can run `goclockify` with the following
109110
$ goclockify
110111
```
111112

112-
### Key Mapping
113+
### Default Key Mapping
114+
115+
**Note**: You can change them in your config file.
113116

114117
| Key | Action |
115118
|--------------------------------------|------------------------------|

internal/widgets/help.go

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
package widgets
99

1010
import (
11+
"fmt"
12+
"github.com/abgeo/goclockify/configs"
1113
w "github.com/gizak/termui/v3/widgets"
1214
)
1315

@@ -28,6 +30,9 @@ Time Entries navigation
2830
Other
2931
- <Escape>: close the 2nd level window, go to the dashboard
3032
- <F1> and ? show this message
33+
34+
You can change default key mapping in your config file:
35+
%s
3136
`
3237

3338
// HelpWidget is a component with the help text
@@ -42,7 +47,7 @@ func NewHelpWidget() *HelpWidget {
4247
}
4348

4449
self.Title = " Help "
45-
self.Text = help
50+
self.Text = fmt.Sprintf(help, configs.FilePath)
4651

4752
return self
4853
}

0 commit comments

Comments
 (0)