aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..01445ac
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# Overview
+
+When opening files in Vim from the shell, this plugin adds an entry to Vim's
+command history in the form `:e foo.rb` . Also, when opening files in Vim,
+adds an entry to the shell history in the form `vim foo.rb` .
+
+# Installation
+
+This plugin can be installed as a standard Vim package (see `:help packages`).
+Simply clone this repository into ~/.vim/pack/plugins/start/vim-history-sync to
+install the Vim files for this plugin.
+
+To enable this plugin, add `. /path/to/vim-history-sync/sh/history-sync.zsh`
+to your .zshrc. Currently only zsh is supported, although patches are welcome
+to add support for other shells.