Skip to content

Commit

Permalink
chore: Improve installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Oliver Weiler committed Nov 6, 2024
1 parent a8af6d1 commit add06c7
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

> Tired of repeatedly typing `cd ..` to walk up the directory tree? Fed up with defining aliases to jump to the first, second or nth parent directory? `up` to the rescue!
up is a tiny shell function which lets you to jump to a parent directory by its name.
up is a tiny shell function which lets you jump to a parent directory by its name.

## :sparkles: Features

Expand All @@ -15,19 +15,30 @@ up is a tiny shell function which lets you to jump to a parent directory by its

## :gear: Installation

### git + Bash
### git & Bash

1. Clone the git repository
Clone `up`'s git repository.

```sh
git clone https://github.com/helpermethod/up ~/.up
```

2. Add the following line to your `.bashrc` (Linux) or `.bash_profile` (macOS)
Add the following line to your `.bashrc` (Linux) or `.bash_profile` (macOS) to install `up`.

```sh
. "$HOME/.up/up"
```

Add the following line to your `.bashrc` (Linux) or `.bash_profile` (macOS) to enable `up`'s Bash completion.

```sh
. "$HOME/.up/completion/bash/up"
```

### git & zsh

TBD

## Usage

TBD

0 comments on commit add06c7

Please sign in to comment.