diff options
| author | Teddy Wing | 2014-12-26 20:20:13 -0500 | 
|---|---|---|
| committer | Teddy Wing | 2014-12-26 20:20:13 -0500 | 
| commit | 9dfccd396abb81d8ea4747f92a9c1018aaf46b9c (patch) | |
| tree | d8d02bd9499e5ee156c370ccdefcace0f3b90fe7 | |
| parent | b481bb162ff1e0ffed71e4e8f8b20f2912a3a812 (diff) | |
| download | git-checkout-history-9dfccd396abb81d8ea4747f92a9c1018aaf46b9c.tar.bz2 | |
README: Update with example & issues
Fill out the README with some useful information. Include a description,
usage example, and a list of issues.
| -rw-r--r-- | README.md | 45 | 
1 files changed, 43 insertions, 2 deletions
| @@ -1,8 +1,49 @@  git-checkout-history  ==================== +Store history of your previously checked out git branches and quickly go back to recent branches. +Here's an example of how it's used: - -	$ git checkout-save a-branch-name +	$ git branch +	* master +	 +	$ git checkout-store -b new-feature +	Switched to a new branch 'new-feature' +	 +	$ git checkout-store -b feature-to-code-review +	Switched to a new branch 'feature-to-code-review' +	 +	$ git checkout-store master +	Switched to branch 'master' +	 +	$ git checkout-history +	[1] feature-to-code-review +	[2] new-feature +	 +	$ git checkout-history 2 +	Switched to branch 'new-feature' +	  	$ git checkout-history +	[1] master +	[2] feature-to-code-review +	[3] new-feature + + +Branch history is stored in a file called `~/.git-checkout-history`. This is a YAML file that contains a list of previously stored branches. + +To make the tool easier to use, git aliases can be used: + +	$ git config --global alias.chs checkout-store +	$ git config --global alias.ch checkout-history +	 +	$ git chs a-branch + + +## 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. + + +## License +Licensed under the MIT license. See the included LICENSE file. | 
