Skip to content

Commit

Permalink
Updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jakearchibald committed Sep 1, 2012
1 parent a74d6e8 commit 2eeb396
Showing 1 changed file with 26 additions and 34 deletions.
60 changes: 26 additions & 34 deletions README.md
Expand Up @@ -24,44 +24,36 @@ eval "$(curl -L https://raw.github.com/jakearchibald/git-convenience/master/setu


## Shortcuts ## Shortcuts


<dl>
<dt>`gs`</dt> * `gs` - git status
<dd>git status</dd> * `gaa` - git add --all - Add all changes (including untracto staging</dd>
<dt>`gaa`</dt> * `gc "Message"` - Commit all changes (except untracked) message</dd>
<dd>git add --all - Add all changes (including untracked) to staging</dd> * `goops` - Add changes to previous commit &amp; edit comessage</dd>
<dt>`gc "Message"`</dt> * `gp` - Pull (via rebase) then push
<dd>Commit all changes (except untracked) with message</dd> * `gup` - Pull (via rebase)
<dt>`goops`</dt> * `glog` - Decorated &amp; graphed log
<dd>Add changes to previous commit &amp; edit commit message</dd> * `gdiff` - A word-diff of changes
<dt>`gp`</dt> * `gclean` - Compress &amp; garbage collect data store
<dd>Pull (via rebase) then push</dd>
<dt>`gup`</dt>
<dd>Pull (via rebase)</dd> 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`.
<dt>`glog`</dt>
<dd>Decorated &amp; graphed log</dd>
<dt>`gdiff`</dt>
<dd>A word-diff of changes</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


![Prompt screenshot](https://raw.github.com/jakearchibald/git-convenience/master/screenshot.png) ![Prompt screenshot](https://raw.github.com/jakearchibald/git-convenience/master/screenshot.png)


The prompt shows the current branch & among other helpful things: The prompt shows the current branch & among other helpful things:


<dl>
<dt>`*`</dt> * `*` - Uncommitted changes
<dd>Uncommitted changes</dd> * `+` - Staged changes
<dt>`%`</dt> * `%` - Untracked files
<dd>Untracked files</dd> * `&lt;` - You're behind the origin
<dt>`&lt;`</dt> * `&gt;` - You're ahead of the origin
<dd>You're behind the origin</dd> * `&lt;&gt;` - You've diverged from the origin
<dt>`&gt;`</dt> * `=` - You're up-to-date with the origin
<dd>You're ahead of the origin</dd>
<dt>`&lt;&gt;`</dt> ## Other tools & props
<dd>You've diverged from the origin</dd>
</dl> * [git-up](https://github.com/aanand/git-up) - A brilliant tool for syncing branches
* [git completion](https://github.com/git/git/tree/master/contrib/completion) - The scripts used for the prompt & tab completion

0 comments on commit 2eeb396

Please sign in to comment.