From dcf3d4019769916c7f1446b06b65203f1ea7b7b5 Mon Sep 17 00:00:00 2001
From: cappyzawa <cappyzawa@yahoo.ne.jp>
Date: Tue, 16 Apr 2019 01:19:45 +0900
Subject: [PATCH] add README

---
 README.md | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 953f242..7472a05 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,33 @@
-# vault.nvim
\ No newline at end of file
+# vault.nvim
+utilities to operate vault
+
+## Required
+* nvim 0.4.0++
+## Installation
+To install using [Vim-Plug](https://github.com/junegunn/vim-plug):
+```
+" add this line to your .vimrc file
+Plug 'cappyzawa/vault.nvim'
+```
+## Supported commands
+|Command|Description|
+|:---|:---|
+|VaultPathPrefix|set your secret path's prefix.|
+|VaultField|set your secret's field. default:`value`.|
+|VaultRead|`vault read -field <field> <path_prefix>/<selected string>`|
+
+## Key mappings
+If `g:vault_no_default_mappings` is not set to `v:true`, this plugin also defines following default mapping.
+
+|Map|Key|Command|
+|:---:|:---:|:---|
+|nmap|<Leader\>vpp|VaultPathPrefix|
+|nmap|<Leader\>vf|VaultField|
+|xmap|<Leader\>vr|VaultRead|
+|nmap|<Leader\>vr|VaultRead|
+
+`VaultRead` reads the secret of the selected string and displays it in the popup window.(xmap) 
+
+When popup is open, execute `VaultRead` to close it.(nmap)
+
+