summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMichael Allen <michael@michaelallen.io>2015-08-25 17:40:41 +0100
committerMichael Allen <michael@michaelallen.io>2015-08-25 17:40:41 +0100
commita93a5552ccb967cfc3b036e4adcecd78dc22ae0f (patch)
tree28d23017923d34e89098650599a567cce291556d /README.md
parent81612cb359baac0b476731aff4eb78e04050f857 (diff)
downloadgit-sonar-a93a5552ccb967cfc3b036e4adcecd78dc22ae0f.tar.gz
git-sonar-a93a5552ccb967cfc3b036e4adcecd78dc22ae0f.zip
Expand the readme slightly
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/README.md b/README.md
index 7af3558..06ca55c 100644
--- a/README.md
+++ b/README.md
@@ -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