Skip to content

Commit a5e82ad

Browse files
author
Oliver Weiler
committed
chore: Describe usage
1 parent a84ada0 commit a5e82ad

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Add the following line to your `.bashrc` (Linux) or `.bash_profile` (macOS) to e
4040
Clone `up`'s Git repository.
4141

4242
```sh
43-
git clone https://github.com/helpermethod/up ~/.up
43+
$ git clone https://github.com/helpermethod/up ~/.up
4444
```
4545

4646
Add the following line to your `.zshrc` to install `up`.
@@ -59,10 +59,23 @@ autoload -U +X bashcompinit && bashcompinit
5959

6060
## Usage
6161

62-
Type `up` followed by pressing the tab key twice to get a list of parent directory names.
62+
Type `up` followed by pressing the `<tab>` key to get the list of parent directory names.
63+
64+
```sh
65+
$ up <tab>
66+
.up / completion helpermethod home
67+
```
68+
69+
Jump to a parent directory by typing `up` followed by the parent directory name.
70+
71+
```
72+
$ up completion
73+
```
74+
75+
You can also autocomplete the parent directory name.
6376

6477
```sh
65-
up <tab><tab>
78+
$ up co<tab>
6679
```
6780

68-
Type `up`
81+
Type `up` without any argument to jump to the parent directory, similar to `cd ..`

0 commit comments

Comments
 (0)