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') + \ }) +```