Skip to content

Commit

Permalink
Indicate more clearly the fork and its changes
Browse files Browse the repository at this point in the history
  • Loading branch information
joeytwiddle committed Mar 18, 2023
1 parent 560c3cb commit b8dbc21
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Git Aware Prompt
# Git Aware Prompt (joeytwiddle's fork)

Working with Git and its great branching/merging features is
amazing. Constantly switching branches can be confusing though as you have to
Expand All @@ -21,13 +21,17 @@ If you `cd` to a Git working directory, you will see the current Git branch
name displayed in your terminal prompt. When you're not in a Git working
directory, your prompt works like normal.

This fork by joeytwiddle also:
.

**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 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).
Expand Down

0 comments on commit b8dbc21

Please sign in to comment.