From 268c350b1a41df24967ea0d54e0438b9e0dd28cd Mon Sep 17 00:00:00 2001
From: Wenxuan <wenxuangm@gmail.com>
Date: Thu, 23 Nov 2017 18:06:09 +0800
Subject: [PATCH] Add README

Former-commit-id: b476991aa7cd6f42217ec693e501d0ffc3897ea7
---
 README.md                     | 54 +++++++++++++++++++++++++++++++++++
 screenshot.png.REMOVED.git-id |  1 +
 2 files changed, 55 insertions(+)
 create mode 100644 README.md
 create mode 100644 screenshot.png.REMOVED.git-id

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`
+
+    `<Ctrl + N/P>`: Selection down/up
+    `<Alt + N/P>`: Preview down/up
+    `<Tab>`: Mark/Unmark and move down
+    `<Enter>`: Confirml and quit
+
+### glo
+
+Interactive `git log`
+
+    `<Ctrl + N/P>`: Selection down/up
+    `<Alt + N/P>`: Preview down/up
+    `<Enter>`: Fullscreen preview
+
+### gd
+
+Interactive `git diff`
+
+    `<Ctrl + N/P>`: Selection down/up
+    `<Alt + N/P>`: Preview down/up
+    `<Enter>`: 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.REMOVED.git-id b/screenshot.png.REMOVED.git-id
new file mode 100644
index 0000000..a27b450
--- /dev/null
+++ b/screenshot.png.REMOVED.git-id
@@ -0,0 +1 @@
+2f28858a3aaa02041913efaa5b4c5f281831a88f
\ No newline at end of file