Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 35 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,43 @@
# vim-ripgrep

## Usage

Search using ripgrep. The word under cursor will be searched if no argument is passed to `Rg`.

:Rg <string|pattern>

Word under cursor will be searched if no argument is passed to `Rg`

## configuration
Show root search dir:

:RgRoot

## Installation


Using [Vim-Plug](https://github.com/junegunn/vim-plug):

Add this to your `~/.vimrc` and run `:PlugInstall`
```vim
Plug 'jremmen/vim-ripgrep'
```


Using [Vundle](https://github.com/VundleVim/Vundle.vim):

Add this to your `~/.vimrc` and run `:PluginInstall`
```vim
Plugin 'jremmen/vim-ripgrep'
```


Using [Pathogen](https://github.com/tpope/vim-pathogen):

Ensure you have `execute pathogen#infect()` in your `~/.vimrc` file and run:
```bash
git clone https://github.com/jremmen/vim-ripgrep.git ~/.vim/bundle
```

## Configuration


| Setting | Default | Details
Expand All @@ -16,9 +49,3 @@ Word under cursor will be searched if no argument is passed to `Rg`
| g:rg_derive_root | false | true if you want to find project root from cwd
| g:rg_root_types | ['.git'] | list of files/dir found in project root
| g:rg_window_location | botright | quickfix window location

## misc

Show root search dir

:RgRoot