add README.md

Author: giannimassi

README.md

@@ -0,0 +1,64 @@
+# git-checkout-interactive
+
+## A cli application for interactively checking out branches
+
+## Installation
+
+```sh
+go get -u github.com/giannimassi/git-checkout-interactive
+```
+
+If $GOBIN is available in your $PATH the command can be used as `git checkout-interactive`.
+
+### Optional
+
+You can also add the following to your `.gitconfig` to provide a simpler to use alias for this command:
+
+```ini
+[alias]
+    cb = checkout-interactive --sort=-committerdate
+```
+
+After adding this alias you can simply call this to choose a branch from the latest ones:
+
+```sh
+git cb
+```
+
+This is just an example, you can add flags and arguments as needed in the alias.
+
+## Usage
+
+```sh
+git checkout-interactive <git branch arguments and flags>
+```
+
+Displays the current branch and allows to circle through branches listed with `git branch` and the provided flag and arguments.
+
+- press down/left/j to select next branch
+- press up/right/h to select previous branch
+- press enter to checkout selected branch
+- press ESC or ctrl-c to exit without any changes
+
+### Examples
+
+```sh
+git checkout-interactive
+```
+
+Choose a branch to checkout among the local branches.
+
+```sh
+git checkout-interactive -a
+```
+
+Choose a branch to checkout among all branches, both local and remote.
+
+```sh
+git checkout-interactive --sort=-committerdate
+```
+
+Choose a branch to checkout among the local branches listed by most recent commit.
+
+
+#### Have fun versioning!

go.mod

@@ -1,11 +1,10 @@
-module github.com/giannimassi/git-checkout-interactive
+module github.com/giannimassi/git-checkout-branch
 
 go 1.13
 
 require (
 	github.com/eiannone/keyboard v0.0.0-20200508000154-caf4b762e807
 	github.com/fatih/color v1.9.0
+	github.com/giannimassi/git-checkout-interactive v0.1.0 // indirect
 	github.com/gosuri/uilive v0.0.4
-	github.com/mattn/go-isatty v0.0.12 // indirect
-	golang.org/x/sys v0.0.0-20200622214017-ed371f2e16b4 // indirect
 )

go.sum

@@ -2,6 +2,8 @@ github.com/eiannone/keyboard v0.0.0-20200508000154-caf4b762e807 h1:jdjd5e68T4R/j
 github.com/eiannone/keyboard v0.0.0-20200508000154-caf4b762e807/go.mod h1:Xoiu5VdKMvbRgHuY7+z64lhu/7lvax/22nzASF6GrO8=
 github.com/fatih/color v1.9.0 h1:8xPHl4/q1VyqGIPif1F+1V3Y3lSmrq01EabUW3CoW5s=
 github.com/fatih/color v1.9.0/go.mod h1:eQcE1qtQxscV5RaZvpXrrb8Drkc3/DdQ+uUYCNjL+zU=
+github.com/giannimassi/git-checkout-interactive v0.1.0 h1:gbbTur4bHop1U1M9uZCy78d4nBLds9Ubh0dDOxuzJ5k=
+github.com/giannimassi/git-checkout-interactive v0.1.0/go.mod h1:2LarWkJjtMJ4kh97ySkJ7zR2CTP2TKe1hCkxieHbsWQ=
 github.com/gosuri/uilive v0.0.4 h1:hUEBpQDj8D8jXgtCdBu7sWsy5sbW/5GhuO8KBwJ2jyY=
 github.com/gosuri/uilive v0.0.4/go.mod h1:V/epo5LjjlDE5RJUcqx8dbw+zc93y5Ya3yg8tfZ74VI=
 github.com/mattn/go-colorable v0.1.4 h1:snbPLB8fVfU9iwbbo30TPtbLRzwWu6aJS6Xh4eaaviA=