From 328b6979f7dc383c40b8e8e292016dbb7f035e4f Mon Sep 17 00:00:00 2001
From: laixintao <laixintao1995@163.com>
Date: Mon, 2 Dec 2019 14:51:53 +0800
Subject: [PATCH] add readme

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..87724f4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# asyncomplete-gitcommit
+
+Git commit message completion source for [asyncomplete.vim](https://github.com/prabirshrestha/asyncomplete.vim)
+
+## Installing
+
+```vim
+Plug 'prabirshrestha/asyncomplete.vim'
+Plug 'laixintao/asyncomplete-gitcommit'
+```
+
+## Register asyncomplete-gitcommit
+
+```vim
+au User asyncomplete_setup call asyncomplete#register_source({
+    \ 'name': 'gitcommit',
+    \ 'whitelist': ['gitcommit'],
+    \ 'priority': 10,
+    \ 'completor': function('asyncomplete#sources#gitcommit#completor')
+    \ })
+```