From 88e2fa380c9430aadaf9d9024d22520612465225 Mon Sep 17 00:00:00 2001 From: "Jeremy Pallats/starcraft.man" Date: Mon, 1 Feb 2016 13:55:22 -0500 Subject: [PATCH] Fix #397: clarify in docs that GitHub is the default plugin source --- README.md | 9 +++++---- plug.vim | 25 ++++++++++++++++++++----- 2 files changed, 25 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 8e5b3ef..13a3114 100644 --- a/README.md +++ b/README.md @@ -63,9 +63,13 @@ Add a vim-plug section to your `~/.vimrc` (or `~/.config/nvim/init.vim` for Neov call plug#begin('~/.vim/plugged') " Make sure you use single quotes -Plug 'junegunn/seoul256.vim' + +" Shorthand notation; fetches https://github.com/junegunn/vim-easy-align Plug 'junegunn/vim-easy-align' +" Any valid git URL is allowed +Plug 'https://github.com/junegunn/vim-github-dashboard.git' + " Group dependencies, vim-snippets depends on ultisnips Plug 'SirVer/ultisnips' | Plug 'honza/vim-snippets' @@ -73,9 +77,6 @@ Plug 'SirVer/ultisnips' | Plug 'honza/vim-snippets' Plug 'scrooloose/nerdtree', { 'on': 'NERDTreeToggle' } Plug 'tpope/vim-fireplace', { 'for': 'clojure' } -" Using git URL -Plug 'https://github.com/junegunn/vim-github-dashboard.git' - " Using a non-master branch Plug 'rdnetto/YCM-Generator', { 'branch': 'stable' } diff --git a/plug.vim b/plug.vim index 5d7410e..3357de5 100644 --- a/plug.vim +++ b/plug.vim @@ -11,9 +11,13 @@ " call plug#begin('~/.vim/plugged') " " " Make sure you use single quotes -" Plug 'junegunn/seoul256.vim' +" +" " Shorthand notation; fetches https://github.com/junegunn/vim-easy-align " Plug 'junegunn/vim-easy-align' " +" " Any valid git URL is allowed +" Plug 'https://github.com/junegunn/vim-github-dashboard.git' +" " " Group dependencies, vim-snippets depends on ultisnips " Plug 'SirVer/ultisnips' | Plug 'honza/vim-snippets' " @@ -21,9 +25,6 @@ " Plug 'scrooloose/nerdtree', { 'on': 'NERDTreeToggle' } " Plug 'tpope/vim-fireplace', { 'for': 'clojure' } " -" " Using git URL -" Plug 'https://github.com/junegunn/vim-github-dashboard.git' -" " " Using a non-master branch " Plug 'rdnetto/YCM-Generator', { 'branch': 'stable' } " @@ -40,7 +41,21 @@ " call plug#end() " " Then reload .vimrc and :PlugInstall to install plugins. -" Visit https://github.com/junegunn/vim-plug for more information. +" +" Plug options: +" +"| Option | Description | +"| ----------------------- | ------------------------------------------------ | +"| `branch`/`tag`/`commit` | Branch/tag/commit of the repository to use | +"| `rtp` | Subdirectory that contains Vim plugin | +"| `dir` | Custom directory for the plugin | +"| `as` | Use different name for the plugin | +"| `do` | Post-update hook (string or funcref) | +"| `on` | On-demand loading: Commands or ``-mappings | +"| `for` | On-demand loading: File types | +"| `frozen` | Do not update unless explicitly specified | +" +" More information: https://github.com/junegunn/vim-plug " " " Copyright (c) 2015 Junegunn Choi