Skip to content

Commit

Permalink
Expand the readme slightly
Browse files Browse the repository at this point in the history
  • Loading branch information
michaeldfallen committed Aug 25, 2015
1 parent 81612cb commit a93a555
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,25 @@ Install from brew:
> brew install michaeldfallen/formula/git-radar
```

Then add to your prompt:
Then run `git-radar` to see the docs and prove it's installed.

## Usage

To use git-radar you need to add it to your prompt. This is done in different
ways depending on your shell.

**Bash**

Add to your `.bashrc`
```bash
export PS1="$PS1$(git-radar --bash)"
export PS1="$PS1$(git-radar --bash --fetch)"
```

**Zsh**

Add to your `.zshrc`
```zsh
export PROMPT="$PROMPT$(git-radar --zsh) "
export PROMPT="$PROMPT$(git-radar --zsh --fetch) "
```

## Features
Expand Down

0 comments on commit a93a555

Please sign in to comment.