summaryrefslogtreecommitdiff
path: root/plugins/vundle/README.md
diff options
context:
space:
mode:
authorSebastian Müller <sbmueller@users.noreply.github.com>2018-10-07 18:17:29 +0200
committerRobby Russell <robby@planetargon.com>2018-10-07 09:17:29 -0700
commitab9d92f66594f1eb20fbd3b067d4d4640cf0da1f (patch)
treedf6b8ce642e49673b1219dca047b144c8f9c75ac /plugins/vundle/README.md
parentca5bbd7526f19d5694ed54422ba99ba22e7c56c8 (diff)
downloadzsh-ab9d92f66594f1eb20fbd3b067d4d4640cf0da1f.tar.gz
zsh-ab9d92f66594f1eb20fbd3b067d4d4640cf0da1f.tar.bz2
zsh-ab9d92f66594f1eb20fbd3b067d4d4640cf0da1f.zip
Add README for vundle plugin (#7245)
Diffstat (limited to 'plugins/vundle/README.md')
-rw-r--r--plugins/vundle/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/plugins/vundle/README.md b/plugins/vundle/README.md
new file mode 100644
index 000000000..499038562
--- /dev/null
+++ b/plugins/vundle/README.md
@@ -0,0 +1,19 @@
+# Vundle plugin
+
+This plugin adds functions to control [vundle](https://github.com/VundleVim/Vundle.vim) plug-in manager for vim.
+
+To use it, add `vundle` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... vundle)
+```
+
+## Functions
+
+| Function | Usage | Description |
+|---------------|-----------------|----------------------------------------------------------------------------|
+| vundle-init | `vundle-init` | Install vundle by cloning git repository into ~/.vim folder |
+| vundle | `vundle` | Install plugins set in .vimrc (equals `:PluginInstall`) |
+| vundle-update | `vundle-update` | Update plugins set in .vimrc (equals `:PluginInstall!`) |
+| vundle-clean | `vundle-clean` | Delete plugins that have been removed from .vimrc (equals `:PluginClean!`) |
+