From bca6e8b4a82327b01ef61ca4644b0b63c0ee02ff Mon Sep 17 00:00:00 2001 From: MightyPork Date: Tue, 29 Jul 2014 15:18:15 +0200 Subject: [PATCH] improved readme --- README.md | 40 +++++++++++++++++++++++++++++++++------- 1 file changed, 33 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 58593f3..8fbbb0b 100644 --- a/README.md +++ b/README.md @@ -2,33 +2,59 @@ lazy-git ======== Script for automating the most common git tasks. +If you are lazy, this may be for you :) Usage ----- -**Check status** +**Clone github repo** + +Commands you want: + +- `git clone https://github.com/MightyPork/lazy-git` + +With LazyGit: + +``` +ghc MightyPork/lazy-git +``` + +**Check git status** + +Commands you want: - `git status` +With LazyGit: + ``` g check ``` - -**Pull from origin/master** - + +**Pull from origin** + +Commands you want: - ` git pull` +With LazyGit: + ``` g pull ``` -**Send to origin/master** - +**Commit and push to origin** + +Commands you want: + - `git status` (if no changes, stop here) - `git add --all` - `git commit -m "...."` (ask for message) -- `git push origin master` +- `git push` + +With LazyGit: ``` g send ``` + +`g send` is interactive, it shows you the changes and prompts for a message.