Skip to content

Commit

Permalink
add mit license
Browse files Browse the repository at this point in the history
  • Loading branch information
cappyzawa committed Apr 15, 2019
1 parent db46d26 commit 8ab50d2
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 cappyzawa (Shu Kutsuzawa)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
54 changes: 54 additions & 0 deletions doc/vault.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
*vault.nvim* utilities to operate vault

Author: cappyzawa <[email protected]>

===============================================================================
CONTENTS *vault-nvim-contents*

Introduction ...... |vault-nvim-introduction|
Interface ...... |vault-nvim-interface|
Variables ...... |vault-nvim-variables|
Commands ...... |vault-nvim-commands|
Mappings ...... |vault-nvim-mappings|
===============================================================================
INTRODUCTION *vault-nvim-introduction*

This plugin can operate vault with you editor, vim.
vault: https://www.vaultproject.io/
===============================================================================
INTERFACE *vault-nvim-interface*
===============================================================================
-------------------------------------------------------------------------------
VARIABLES *vault-nvim-variables*
*g:vault_no_default_mapping*
(Default: v:false)
If this variable is set to v:true, you can disable default key mapping.
-------------------------------------------------------------------------------
COMMANDS *vault-nvim-commands*
*:VaultPathPrefix*
default: ''.
Path under which to namespace credential lookup.
if you set `/foo` to path prefix, and you select `bar` in editor, you can
read select `/foo/bar`.
*:VaultField*
default: 'value'.
The field with the given name.
If you wrote secret by below command, field is `value`.
`vault write /foo/bar value=foobar`

*:VaultRead*
This command reads `<path_prefix>/<selected_string>`.
if you set `/foo` to path prefix, and you select `bar` in editor, you can
read select `/foo/bar`.

*:VaultWrite* (TBD: comming soon?)
-------------------------------------------------------------------------------
MAPPINGS *vault-nvim-mappings*
*<Leader>vpp*
VaultPathPrefix
*<Leader>vf*
VaultField
*<Leader>vr*
VaultRead
*<Leader>vw*
VaultWrite (TBD)

0 comments on commit 8ab50d2

Please sign in to comment.