Skip to content

Commit

Permalink
Updated README for recent features
Browse files Browse the repository at this point in the history
  • Loading branch information
joeytwiddle committed Sep 2, 2016
1 parent 8eb15ef commit f2bffbe
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,14 @@ directory, your prompt works like normal.
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
- indicates when you have an un-popped **stash** (when the top stash entry was made on the current commit or the current 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.
Expand Down

0 comments on commit f2bffbe

Please sign in to comment.