aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTeddy Wing2014-11-23 16:29:00 -0500
committerTeddy Wing2014-11-23 16:31:31 -0500
commitd07492d176055a4b20cc7c2d1b1660968218fb5b (patch)
treee9ce726e961e34344c8d5dcf074d52a4b5ece544 /README.md
parentb6a5596cb604ef4a6ec8b33703f752ee03e01697 (diff)
downloadvim-ls-grep-d07492d176055a4b20cc7c2d1b1660968218fb5b.tar.bz2
Add README
Basic explanation of what the plugin does, usage, and installation instructions. Still need to write a Vim help file.
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f0e8dec
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+ls_grep.vim
+===========
+
+Provide support for grepping `:ls` output. Say you have 20 buffers open. To find the buffer id of a file, filtering visually can take a long time. This plugin allows you to filter the output to only show the lines matching your search term.
+
+
+## Usage
+
+ :LsGrep filename
+
+
+## Installation
+Install using any of the various Vim package management plugins. If you use [pathogen](https://github.com/tpope/vim-pathogen), you can run the following to install:
+
+ cd ~/.vim/bundle
+ git clone https://github.com/teddywing/auditory.vim.git
+
+
+## License
+Licensed under the MIT license. See the included LICENSE file.