diff --git a/README.md b/README.md index 5ef7531..bcd35bb 100644 --- a/README.md +++ b/README.md @@ -47,22 +47,23 @@ at it. That, **and colorful file icons and git indicators!**. ## Dependencies -- `Linux` or `MacOS` only, see [nvim-fzf's How it - works](https://github.com/vijaymarupudi/nvim-fzf#How-it-works) +- `Linux` or `MacOS` +- [`neovim`](https://github.com/neovim/neovim/releases) version > 0.5.0 - [`fzf`](https://github.com/junegunn/fzf) or [`skim`](https://github.com/lotabout/skim) binary installed - [nvim-fzf](https://github.com/vijaymarupudi/nvim-fzf) - [nvim-web-devicons](https://github.com/kyazdani42/nvim-web-devicons) (optional) -### Optional dependencies - -Recommended optional utilities: - -- [fd](https://github.com/sharkdp/fd) - better performance `find` utility -- [bat](https://github.com/sharkdp/bat) - for colorful syntax highlighted previews -- [ripgrep](https://github.com/BurntSushi/ripgrep) - for better grep-like searches +### Optional dependencies (recommended) +- [fd](https://github.com/sharkdp/fd) - better `find` utility +- [rg](https://github.com/BurntSushi/ripgrep) - better `grep` utility +- [bat](https://github.com/sharkdp/bat) - syntax highlighted previews when + using fzf's native previewer +- [delta](https://github.com/dandavison/delta) - syntax highlighted git pager + for git status previews + ## Installation Using [vim-plug](https://github.com/junegunn/vim-plug) @@ -349,6 +350,7 @@ require'fzf-lua'.setup { git_diff = { cmd = "git diff", args = "--color", + -- pager = "delta", -- if you have `delta` installed }, man = { cmd = "man -c %s | col -bx", diff --git a/doc/fzf-lua.txt b/doc/fzf-lua.txt index 6834b6c..2901f37 100644 --- a/doc/fzf-lua.txt +++ b/doc/fzf-lua.txt @@ -59,8 +59,8 @@ throw at it. That, and colorful file icons and git indicators!. DEPENDENCIES *fzf-lua-dependencies* -- `Linux` or `MacOS` only, see nvim-fzf's How it - works +- `Linux` or `MacOS` +- `neovim` version > 0.5.0 - `fzf` or `skim` binary installed - nvim-fzf @@ -68,13 +68,14 @@ DEPENDENCIES *fzf-lua-dependencies* (optional) -OPTIONAL DEPENDENCIES *fzf-lua-optional-dependencies* +OPTIONAL DEPENDENCIES (RECOMMENDED)*fzf-lua-optional-dependencies-(recommended)* -Recommended optional utilities: - -- fd - better performance `find` utility -- bat - for colorful syntax highlighted previews -- ripgrep - for better grep-like searches +- fd - better `find` utility +- rg - better `grep` utility +- bat - syntax highlighted previews when + using fzf's native previewer +- delta - syntax highlighted git pager + for git status previews ------------------------------------------------------------------------------ INSTALLATION *fzf-lua-installation* @@ -383,6 +384,7 @@ Consult the list below for available settings: git_diff = { cmd = "git diff", args = "--color", + -- pager = "delta", -- if you have `delta` installed }, man = { cmd = "man -c %s | col -bx",