From b84c7094fdc94f9341e6041ff229c4341f9f412b Mon Sep 17 00:00:00 2001 From: Junegunn Choi Date: Wed, 11 Sep 2013 00:08:51 +0900 Subject: [PATCH] Update doc --- README.md | 37 ++++++++++++++++--------------------- 1 file changed, 16 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 8e4cad4..769d749 100644 --- a/README.md +++ b/README.md @@ -3,32 +3,27 @@ vim-plug Vim plugin manager. -Why? ----- +### Why? Because I can? -Pros. ------ +### Pros. - Marginally simpler - Parallel installation/update (requires +ruby) - Alternative directory structure: user/repo/branch -Cons. ------ +### Cons. Everything else. -Usage ------ +### Usage Download plug.vim and put it in ~/.vim/autoload ```sh mkdir -p ~/.vim/autoload -curl -fL -o ~/.vim/autoload/plug.vim \ - https://raw.github.com/junegunn/vim-plug/master/plug.vim +curl -fL -o ~/.vim/autoload/plug.vim https://raw.github.com/junegunn/vim-plug/master/plug.vim ``` Edit your .vimrc @@ -42,18 +37,18 @@ Plug 'junegunn/vim-easy-align' " ... ``` -Then :PlugInstall to install plugins. (default: ~/.vim/plugged) -You can change the location of the plugins with plug#init(path) call. +Then :PlugInstall to install plugins. (Default plugin directory: `~/.vim/plugged`) -Commands --------- +You can change the location of the plugins with `plug#init(path)` call. -| Command | Argument | Description | -| ----------- | ---------- | ------------------------- | -| PlugInstall | [#threads] | Install plugins | -| PlugUpdate | [#threads] | Install or update plugins | -| PlugClean | | Remove unused directories | -| PlugUpgrade | | Upgrade vim-plug itself | +### Commands -(#threads default = number of plugins) +| Command | Description | +| ---------------------- | ------------------------- | +| PlugInstall [#threads] | Install plugins | +| PlugUpdate [#threads] | Install or update plugins | +| PlugClean | Remove unused directories | +| PlugUpgrade | Upgrade vim-plug itself | + +(Default #threads = Number of plugins)