Permalink
Browse files

Info on prompt

  • Loading branch information...
1 parent 2ea5355 commit a74d6e8340fad142a20b6ce99fa7de277418f3bb @jakearchibald committed Sep 1, 2012
Showing with 33 additions and 12 deletions.
  1. +33 −12 README.md
View
@@ -25,22 +25,43 @@ eval "$(curl -L https://raw.github.com/jakearchibald/git-convenience/master/setu
## Shortcuts
<dl>
-<dt>gs</dt>
+<dt>`gs`</dt>
<dd>git status</dd>
-<dt>gaa</dt>
+<dt>`gaa`</dt>
<dd>git add --all - Add all changes (including untracked) to staging</dd>
-<dt>gc "Message"</dt>
+<dt>`gc "Message"`</dt>
<dd>Commit all changes (except untracked) with message</dd>
-<dt>goops</dt>
-<dd>Add changes to previous commit & edit commit message</dd>
-<dt>gp</dt>
+<dt>`goops`</dt>
+<dd>Add changes to previous commit &amp; edit commit message</dd>
+<dt>`gp`</dt>
<dd>Pull (via rebase) then push</dd>
-<dt>gup</dt>
+<dt>`gup`</dt>
<dd>Pull (via rebase)</dd>
-<dt>glog</dt>
-<dd>Decorated & graphed log</dd>
-<dt>gdiff</dt>
+<dt>`glog`</dt>
+<dd>Decorated &amp; graphed log</dd>
+<dt>`gdiff`</dt>
<dd>A word-diff of changes</dd>
-<dt>gclean</dt>
-<dd>Compress & garbage collect data store</dd>
+<dt>`gclean`</dt>
+<dd>Compress &amp; garbage collect data store</dd>
+</dl>
+
+If you've installed the wonderful [git-up]https://github.com/aanand/git-up (which you should), it'll be used instead of `git pull --rebase`.
+
+## Prompt
+
+![Prompt screenshot](https://raw.github.com/jakearchibald/git-convenience/master/screenshot.png)
+
+The prompt shows the current branch & among other helpful things:
+
+<dl>
+<dt>`*`</dt>
+<dd>Uncommitted changes</dd>
+<dt>`%`</dt>
+<dd>Untracked files</dd>
+<dt>`&lt;`</dt>
+<dd>You're behind the origin</dd>
+<dt>`&gt;`</dt>
+<dd>You're ahead of the origin</dd>
+<dt>`&lt;&gt;`</dt>
+<dd>You've diverged from the origin</dd>
</dl>

0 comments on commit a74d6e8

Please sign in to comment.