aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2015-01-06 17:10:26 -0500
committerTeddy Wing2015-01-06 17:10:26 -0500
commitcf5979a4933e2adcec1fac256f45cff66da16ece (patch)
treecca6ebd3322362f19c6cf35fab2fa897c81e9c44
parent6e1bbd5123539999bb43135a0a1e9a2722fba2c5 (diff)
downloadgit-checkout-history-cf5979a4933e2adcec1fac256f45cff66da16ece.tar.bz2
README: Add information about shell completion
A note and installation instructions for shell completion of `git-checkout-store`.
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index bca61f8..d09ff8c 100644
--- a/README.md
+++ b/README.md
@@ -51,6 +51,12 @@ Run these commands to build `git-checkout-history` and `git-checkout-store`:
$ go install github.com/teddywing/git-checkout-history/git-checkout-store
+## Shell Completion
+If you use bash or zsh completion for git, a patch file is included to add this functionality for `git-checkout-store`. The patch enables `checkout-store` to have the same completion functionality as `checkout`. It can be applied as usual:
+
+ $ patch path/to/git-completion.bash < path/to/git-completion.bash.patch
+
+
## Known Issues
* Currently, branch history is stored globally. When used in multiple repositories, all branches go to the same list. There should be a different branch storage list for each repository.
* History never gets cleared. Not sure if this is actually an issue, but personally I don't really care about branch history from before the current day.