Permalink
Browse files

Update the README.

  • Loading branch information...
1 parent 734f07a commit dc40c1bc5ed89f459472985393cec0153ccc4a38 @jszakmeister committed Jan 20, 2013
Showing with 13 additions and 1 deletion.
  1. +13 −1 README.rst
View
@@ -2,4 +2,16 @@ togglecursor
============
This plugin aims to provide the ability to change the cursor when entering Vim's
-insert mode on terminals that support it.
+insert mode on terminals that support it. Currently, that's limited to iTerm,
+Konsole, and xterm is partially supported (creates an underline cursor instead
+of line, by default).
+
+Installation
+------------
+
+Unzip into ``~/.vim`` (or ``%USERPROFILE%\vimfiles`` on Windows). You may also
+install it under pathogen by extracting it into it's own directory under
+``bundle``, such as ``~/.vim/bundle/vim-togglecursor``.
+
+The latest version can be obtained from:
+ https://github.com/jszakmeister/vim-togglecursor

0 comments on commit dc40c1b

Please sign in to comment.