Skip to content
/ zeit Public

Commit 755fe36

Browse files
committed
Update README, add autocompletion info
1 parent 689b077 commit 755fe36

File tree

1 file changed

+29
-8
lines changed

1 file changed

+29
-8
lines changed

README.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ LICENSE](https://img.shields.io/static/v1?label=SEGV%20LICENSE&message=1.0&label
77

88
[<img src="https://xn--gckvb8fzb.com/images/chatroom.png" width="275">](https://xn--gckvb8fzb.com/contact/)
99

10-
Zeit, erfassen. A command line tool for tracking time spent on tasks & projects.
10+
_Zeit, erfassen_. A command line tool for tracking time spent on tasks &
11+
projects.
1112

1213
[Download the latest version for macOS, Linux, FreeBSD, NetBSD, OpenBSD & Plan9
1314
here](https://github.com/mrusme/zeit/releases/latest).
@@ -24,7 +25,7 @@ the version in `zeit --help` to be a different one.
2425

2526
## Understand
2627

27-
_zeit_'s data structure contains of the following key entities:
28+
_Zeit_'s data structure contains of the following key entities:
2829

2930
- `block`: A tracked time period that has a start and an end date/time
3031
- `project`: A top-level project
@@ -40,25 +41,45 @@ configured using the `zeit project` and the `zeit task` commands.
4041

4142
### Auto-Completion
4243

43-
_zeit_ can generate auto-completion scripts for your shell of choice. You can
44+
_Zeit_ can generate auto-completion scripts for your shell of choice. You can
4445
load completions into your current session via:
4546

4647
```sh
47-
source <(zeit completion bash)
48+
source <(zeit completion $(basename "$SHELL"))
4849
```
4950

50-
(replace `bash` with your shell, e.g. `zsh`, `fish`, `powershell`)
51+
(supported shells are `bash`, `zsh`, and `fish`; For PowerShell see below)
5152

5253
To load completions for every new session, add them to your completions
53-
directory, e.g.:
54+
directory.
5455

56+
For Bash:
57+
58+
```sh
59+
zeit completion bash > ~/.local/share/bash-completion/completions/zeit
5560
```
56-
sudo zeit completion bash > /etc/bash_completion.d/zeit
61+
62+
For Zsh:
63+
64+
```sh
65+
zeit completion zsh > ~/.local/share/zsh/completions/zeit
66+
```
67+
68+
For Fish:
69+
70+
```sh
71+
zeit completion fish > ~/.config/fish/completions/zeit.fish
72+
```
73+
74+
For PowerShell:
75+
76+
```sh
77+
zeit completion powershell | Out-String | Invoke-Expression
5778
```
5879

5980
## Integrations
6081

61-
This is a list of integrations and extensions that work with _zeit_:
82+
This is a list of integrations and extensions that work with _Zeit_:
6283

6384
| Integration | Description | Author |
6485
| ----------- | ----------- | ------ |

0 commit comments

Comments
 (0)