aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2018-02-21 01:24:31 +0100
committerTeddy Wing2018-02-21 01:25:03 +0100
commitada8c053bd731c7b017136ecedb08f3480d5ca74 (patch)
tree95c44a3b96c1076b0374aee83bcc345b09575ad1
parent440bbed06f05a7521966cf49b572498cb1be0cec (diff)
downloadgit-branch-list-ada8c053bd731c7b017136ecedb08f3480d5ca74.tar.bz2
Add READMEv0.0.1
Include a description, an example shell session, and license information.
-rw-r--r--README.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cf4bb22
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+git-branch-list
+===============
+
+A Git add-on that allows you to maintain a list of branches to check out
+quickly. Branches can be added and removed from the list, and checked out using
+their ID. This makes it easier to switch between a group of active branches for
+development and code review tasks by eliminating the need to remember branch
+names.
+
+
+## Example
+
+ $ git branch
+ 3254-make-logo-bigger
+ * 3901-eliminate-CombinationService
+ 4011-catalog--populate-drop-down-via-AJAX
+ master
+ $ git branch-list save
+ $ git branch-list
+ 1 3901-eliminate-CombinationService
+ $ git branch-list save 3254-make-logo-bigger
+ $ git branch-list
+ 1 3254-make-logo-bigger
+ 2 3901-eliminate-CombinationService
+ $ git checkout 4011-catalog--populate-drop-down-via-AJAX
+ Switched to branch '4011-catalog--populate-drop-down-via-AJAX'
+ $ git branch-list save
+ $ git branch-list
+ 1 4011-catalog--populate-drop-down-via-AJAX
+ 2 3254-make-logo-bigger
+ 3 3901-eliminate-CombinationService
+ $ git branch-list 3
+ Switched to branch '3901-eliminate-CombinationService'
+ $ git branch-list drop 3
+ $ git branch-list
+ 1 4011-catalog--populate-drop-down-via-AJAX
+ 2 3254-make-logo-bigger
+
+
+## Install
+
+
+## License
+Copyright © 2018 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
+COPYING file).