Skip to content

Commit 45d8c2a

Browse files
authored
CIO-94 (#112)
* CIO-94 Add usage gifs * CIO-94 Update usage gif. Update readme * CIO-94 Update readme gifs * CIO-94 Add introduction gif
1 parent 85a1b26 commit 45d8c2a

File tree

4 files changed

+15
-2
lines changed

4 files changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
# Check It Out
2+
![Check It Out](./assets/images/checkit-intro.gif)
3+
24
[![npm version](https://badge.fury.io/js/check-it-out.svg)](https://badge.fury.io/js/check-it-out) [![GitHub version](https://badge.fury.io/gh/jwu910%2Fcheck-it-out.svg)](https://badge.fury.io/gh/jwu910%2Fcheck-it-out)
5+
36
Check it out, before you checkout.
47

5-
Too many keystrokes just to checkout a branch? Tired of long branch names? Don't remember what branches are available? Don't be bothered by fix-a-bug-where-code-is-broken-because-bad branch names any more! Check It Out gives you the interactive power to see your branches and check them out with fewer keystrokes.
8+
Change branches with a single command. Check It Out visualizes branches and remotes in your current project. Long Branch Names? Forget it!
9+
10+
Fewer commands, fewer keystrokes, better productivity!
611

712
## Requirements
8-
[Node >= v7.0](https://nodejs.org/en/blog/release/v7.0.0/) - Required for async/await
13+
[Node >= v6.0](https://nodejs.org/en/blog/release/v6.0.0/)
14+
915
[Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) - Required for core features
1016

1117
## Installation
@@ -39,6 +45,13 @@ Run this command to list local and remote branches!
3945
checkit
4046
```
4147

48+
![Check It Out Usage](./assets/images/checkit-usage.gif)
49+
50+
Call git log on current highlighted branch with `[space]`
51+
52+
![Quick Git Log!](./assets/images/checkit-log.gif)
53+
54+
4255
| Commands | Description |
4356
| -------- | ------------ |
4457
|`j/k, down/up`| Navigate the list |

assets/images/checkit-intro.gif

269 KB
Loading

assets/images/checkit-log.gif

1.49 MB
Loading

assets/images/checkit-usage.gif

818 KB
Loading

0 commit comments

Comments
 (0)