summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorClaudio Bandera <claudio.bandera@kit.edu>2015-09-17 18:27:40 +0200
committerClaudio Bandera <claudio.bandera@kit.edu>2015-09-17 18:27:40 +0200
commitd73b8d0697a4e7fdeb65e1b13ec6d3020d8efed9 (patch)
tree38cb16fca88c76dbd5b01e257095796e93120c24 /README.md
parent5adc604fc1b0c11af8a85928e2a7d756fc5ad776 (diff)
downloadgit-sonar-d73b8d0697a4e7fdeb65e1b13ec6d3020d8efed9.tar.gz
git-sonar-d73b8d0697a4e7fdeb65e1b13ec6d3020d8efed9.zip
Added documentation for stash feature.
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1538681..77eb8cc 100644
--- a/README.md
+++ b/README.md
@@ -148,6 +148,13 @@ Prompt | Meaning
If you don't rely on this status, you can always hide this part of the prompt by calling git-radar with `--no-remote-status`.
+### Stash status
+The prompt will show you whether and how many stashes you have stored.
+
+Prompt | Meaning
+---------------------------|---------------
+![git:(master) 1≡] | We have one stash
+
**Bash**
```bash
export PS1="$PS1\$(git-radar --bash --fetch --no-remote-status) "
@@ -467,6 +474,18 @@ tracked by git.
It is unset by `GIT_RADAR_COLOR_CHANGES_RESET` which you can set if you want
a different background colour to return to.
+##### Colouring the stash status
+
+**GIT_RADAR_COLOR_STASH='[colour code]'**
+```
+git:(my-branch) 1≡
+ ^
+```
+The colour to use for the lines that indicates how many stashes you have stored.
+
+It is unset by `GIT_RADAR_COLOR_STASH_RESET` which you can set if you want
+a different background colour to return to.
+
## License
Git Radar is licensed under the MIT license.