diff options
| author | Mike JS. Choi <mkchoi212@icloud.com> | 2018-01-01 12:14:24 -0600 |
|---|---|---|
| committer | Mike JS. Choi <mkchoi212@icloud.com> | 2018-01-01 12:14:24 -0600 |
| commit | 38f82ee7565031108c9427e68a46b8f57004342b (patch) | |
| tree | a73b438595ace37ae1c4bfe6050ff27401d59000 | |
| parent | aa7da564532ec9c8e9a04335ca0d6a3bf024e8e6 (diff) | |
Update README
| -rw-r--r-- | README.md | 51 |
1 files changed, 50 insertions, 1 deletions
@@ -1,5 +1,5 @@ <p align="center">
- <img src="header.png">
+ <img src="./assets/header.png">
<p align="center">
Easy-to-use CUI for fixing git conflicts
<br>
@@ -8,5 +8,54 @@ </p>
<br>
+I never really liked any of the `mergetools` out there so I made a simple program that does simple things… in a simple fashion.
+
+
+
+## 👷 Installation
+
+Execute:
+
+```bash
+$ go get github.com/mkchoi212/fac
+```
+
+## Using
+
+`fac` operates much like `git add -p` . It has a prompt input at the bottom of the screen where the user inputs various commands.
+
+The commands have been preset to the following specifications
+
+```
+w - show more lines up
+s - show more lines down
+a - select left screen
+d - select right screen
+
+j - scroll down
+k - scroll up
+
+v - [v]iew orientation
+n - [n]ext conflict
+p - [p]revious conflict
+
+h | ? - [h]elp
+q | Ctrl+c - [q]uit
+
+[wasd] >> [INPUT HERE]
+```
+
+
+
+> The movement controls have been derived from both the world of gamers (WASD) and VIM users (HJKL).
+
+## ✋ Contributing
+
+This is an open source project so feel free to contribute by
+
+- Opening an [issue](https://github.com/mkchoi212/fac/issues/new)
+- Sending me feedback via [email](mailto://mkchoi212@icloud.com)
+- Or [tweet](https://twitter.com/Bananamlkshake2) at me!
+
## 👮 License
See [License](./LICENSE)
|