From d73b8d0697a4e7fdeb65e1b13ec6d3020d8efed9 Mon Sep 17 00:00:00 2001 From: Claudio Bandera Date: Thu, 17 Sep 2015 18:27:40 +0200 Subject: Added documentation for stash feature. --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'README.md') 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. -- cgit v1.2.3 From ff0bd7c685d124ac184944d0c1eeedf010106189 Mon Sep 17 00:00:00 2001 From: Scott Stevenson Date: Wed, 7 Oct 2015 08:15:21 +0100 Subject: Add missing character in Fish snippet --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1538681..51b1c50 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ Add to your `config.fish` function fish_prompt set_color $fish_color_cwd echo -n (prompt_pwd) - git-radar --fish -fetch + git-radar --fish --fetch set_color normal echo -n ' > ' end -- cgit v1.2.3 From 79998cbdc6f7bf7cd87f86926df07a33e4705655 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?I=C3=B1aki=20Abete?= Date: Thu, 15 Oct 2015 16:09:59 -0300 Subject: Fix typo on GIT_RADAR_FORMAT examples #65 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3ef156d..18e5f46 100644 --- a/README.md +++ b/README.md @@ -203,8 +203,8 @@ of the corresponding feature. GIT_RADAR_FORMAT | Result --------------------------------------|--------------------- -`${branch}%{local}%{changes}` | `master1↑1M` -`[${branch}] - %{local} - %{changes}` | `[master] - 1↑ - 1M` +`%{branch}%{local}%{changes}` | `master1↑1M` +`[%{branch}] - %{local} - %{changes}` | `[master] - 1↑ - 1M` ### Prefixing and Suffixing the features -- cgit v1.2.3 From 4cd0f2683c43cff423f85de4c1c74831fb3f1bbb Mon Sep 17 00:00:00 2001 From: Michael Allen Date: Fri, 16 Oct 2015 14:13:27 +0100 Subject: Update README and include stash in customisation options --- README.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 3e52a70..bd30798 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ last few years. Maybe it can help you too. - [Files status](#files-status) - [Local commits status](#local-commits-status) - [Remote commits status](#remote-commits-status) + - [Stash status](#stash-status) - [(Optional) Auto-fetch repos](#optional-auto-fetch-repos) - [Customise your prompt](#customise-your-prompt) - [Support](#support) @@ -201,6 +202,7 @@ Remote commits | `%{remote}` Local commits | `%{local}` Branch | `%{branch}` File changes | `%{changes}` +Stashes | `%{stash}` You can create any prompt shape you prefer by exporting `GIT_RADAR_FORMAT` with your preferred shape. The control strings above will be replaced with the output @@ -536,6 +538,7 @@ Git Radar is licensed under the MIT license. See [LICENSE] for the full license text. [LICENSE]: https://github.com/michaeldfallen/git-radar/blob/master/LICENSE +[git:(master) 1≡]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/stash.png [git:(master) 3A]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/untracked.png [git:(master) 2D2M]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/unstaged.png [git:(master) 1M1R]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/added.png -- cgit v1.2.3