From 2e4c5517bf430825fa0d43c30a292445e5e77541 Mon Sep 17 00:00:00 2001 From: Paul Joey Clark Date: Fri, 2 Sep 2016 11:46:36 +0800 Subject: [PATCH] Updated README for recent features --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 02cbe6e..4a78ceb 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,13 @@ This fork by joeytwiddle also: - shows you how far your local branch is **ahead** or **behind** the repository's branch - shows how many files are **staged** - indicates when the top **stash** entry was based on the current commit or branch +- displays when you are on a **detached** commit, or paused during a merge, rebase or cherry-pick - adds a **timeout** for slower machines so that you will get your prompt quickly, even if `git status` is taking too long to retrieve the dirty and staged stats. (Tested in bash and zsh.) If you *only* want the ahead/behind marks (no timeout and no staged stats), you may prefer the branch [ahead_behind](https://github.com/joeytwiddle/git-aware-prompt/tree/ahead_behind) or if you are curious about the code, see [ahead_behind_simple](https://github.com/joeytwiddle/git-aware-prompt/tree/ahead_behind_simple) ([compare](https://github.com/joeytwiddle/git-aware-prompt/compare/jimeh:518685d5d42ab9f298207dd66bbc213775c5cbee...ahead_behind_simple?expand=1)). +The initial implementation of the timeout feature is on [this commit](https://github.com/joeytwiddle/git-aware-prompt/commit/29a89c1e6890689c819303ad33ef70ae4233589c). + ![Git Branch in Prompt](https://raw.github.com/joeytwiddle/git-aware-prompt/master/preview.png) > `<3` indicates that the local branch is 3 commits behind the upstream/remote branch, and could be updated.