From a93a5552ccb967cfc3b036e4adcecd78dc22ae0f Mon Sep 17 00:00:00 2001 From: Michael Allen Date: Tue, 25 Aug 2015 17:40:41 +0100 Subject: Expand the readme slightly --- README.md | 11 ++++++++--- 1 file 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 -- cgit v1.2.3