diff --git a/README.md b/README.md index 8fe533e..14c99c6 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,12 @@ -lazy-git -======== +# lazy-git + Script for automating the most common git tasks. If you are lazy, this may be for you :) -Usage ------ +## Usage -**Clone github repo** +### Clone github repo Commands you want: @@ -19,7 +18,7 @@ With LazyGit: ghc MightyPork/lazy-git ``` -**Check git status** +### Check git status Commands you want: @@ -31,7 +30,7 @@ With LazyGit: g check ``` -**Pull from origin** +### Pull from origin Commands you want: - ` git pull` @@ -42,7 +41,7 @@ With LazyGit: g pull ``` -**Commit and push to origin** +### Add all, commit and push Commands you want: @@ -58,10 +57,9 @@ g send ``` `g send` is interactive, it shows you the changes and prompts for a message. +The operation can be canceled without damage by hitting ^C at the commit prompt. -**Commit without push** - -Commands you want: +### Add all & commit (without push) This is like `g send`, but without pushing the result. Use `g push` or `git push` to send your new commits to the server. @@ -70,3 +68,4 @@ to send your new commits to the server. g add ``` +(`g commit` and `g stage` are aliases)