add readme.

1 files changed, 42 insertions, 0 deletions

diff --git a/README.mkd b/README.mkd
new file mode 100644
index 0000000..741f63f
--- /dev/null
+++ b/README.mkd
@@ -0,0 +1,42 @@
+templete-vim
+============
+
+template chooser for vim
+
+Usage:
+------
+
+Open new file
+
+```sh
+# vim foo.pl
+```
+
+```vim
+:Template <tab>
+```
+
+Then you can select `package` or `script` for perl filetype.
+
+```vim
+:Template package
+:Template script
+```
+
+Type <enter> in 'script', you can see following.
+
+```perl
+use strict;
+use warnings
+use utf8;
+
+|
+```
+
+And cursor is in '|'. If you open C++ file, you can select `main` for C.
+
+Author:
+-------
+
+Yasuhiro Matsumoto `<mattn.jp@gmail.com>`
+