From 3c33051798074c995270e184c4dd54e84184f5a3 Mon Sep 17 00:00:00 2001 From: George Brocklehurst Date: Tue, 10 Dec 2013 19:48:24 +0100 Subject: [PATCH] Add benefits to README (closes #39) --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 4c684786..9af164d0 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,23 @@ The `gitsh` program is an interactive shell for git. From within `gitsh` you can issue any git command, even using your local aliases and configuration. +## Why should you use gitsh? + +* Avoid typing `git` over and over and over: + + sh$ gitsh + gitsh% status + gitsh% add . + gitsh% commit -m "Ship it!" + +* Hit return with no command to run `git status`, saving even more + typing. +* Tab completion for git commands, aliases, and branches without modifying your + shell settings, and without any extra setup for aliases and third party + git commands. +* Information about the state of your git repository in the prompt, without + modifying your shell settings. + ## Installing gitsh * On Mac OS X, via homebrew: