aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorChris Toomey2014-06-06 12:46:49 -0400
committerChris Toomey2014-06-06 12:53:54 -0400
commit815bdef7c0bb6eab62c48d34b85b4082f0566a5d (patch)
tree245c7be128e7baad1b03583e9c2307e7eaae909a /README.md
parentb72b05e853322297f6ecda523fef55c5d3899595 (diff)
downloadvim-system-copy-815bdef7c0bb6eab62c48d34b85b4082f0566a5d.tar.bz2
Expand on readme usage and install
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 31 insertions, 3 deletions
diff --git a/README.md b/README.md
index 48c1afb..4a8082a 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,36 @@
System Copy
===========
+System copy provides vim mappings for copying text to the clipboard on OS X
+using `pbcopy`. Most people will be happy just setting their Vim clipboard to
+the system clipboard, but I find that doing so pollutes my clipboard history.
+Instead, this plugin creates a unique mapping that explicitly pulls content
+from Vim into the system clipboard.
+
+Usage
+-----
+
System copy provides a mapping to copy to the system clipboard. It accepts a
-motion or can be used with a visual selction.
+motion or can be used with a visual selection.
+
+The default mapping is `cp`, and can be followed by any motion or text
+object. For instance:
+
+- `cpiw` => copy word into system clipboard
+- `cpi'` => copy inside single quotes to system clipboard
+
+In addition, `cP` is mapped to copy the current line directly.
+
+Installation
+------------
+
+If you don't have a preferred installation method, I recommend using [Vundle][].
+Assuming you have Vundle installed and configured, the following steps will
+install the plugin:
+
+Add the following line to your `~/.vimrc` and then run `BundleInstall` from
+within Vim:
-`cpiw` => copy word into system clipboard
-`cpi'` => copy inside single quotes to system clipboard
+``` vim
+Bundle 'christoomey/vim-system-copy'
+```