diff --git a/README.md b/README.md new file mode 100644 index 0000000..e205843 --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +# forgit + +`forgit` is a utility tool for git taking advantage of fuzzy finder [`fzf`](https://github.com/junegunn/fzf) + +## Demo + +![screenshot](screenshot.png) + +## Install + +### zplug([Recommand](https://github.com/zplug/zplug)) + +Just add this line to your zshrc: + + `zplug 'wfxr/forgit', defer:1` + +### Manually + +Clone this repo somewhere and source the `forgit.plugin.zsh` at ~/.zshrc. + +## Commands + +### ga + +Interactive `git add` + + ``: Selection down/up + ``: Preview down/up + ``: Mark/Unmark and move down + ``: Confirml and quit + +### glo + +Interactive `git log` + + ``: Selection down/up + ``: Preview down/up + ``: Fullscreen preview + +### gd + +Interactive `git diff` + + ``: Selection down/up + ``: Preview down/up + ``: Fullscreen preview + +### gi + +Interactive `.gitignore` generator + +### Tips + +Install [`diff-so-fancy`](https://github.com/so-fancy/diff-so-fancy) for better quality of diff result. \ No newline at end of file diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..2f28858 Binary files /dev/null and b/screenshot.png differ