diff --git a/README.md b/README.md index 6c1e189..2adfda1 100644 --- a/README.md +++ b/README.md @@ -48,12 +48,16 @@ at it. That, **and colorful file icons and git indicators!**. ## Dependencies - `Linux` or `MacOS` -- [`neovim`](https://github.com/neovim/neovim/releases) version > 0.5.0 -- [`fzf`](https://github.com/junegunn/fzf) version > 0.24.0 **or** - [`skim`](https://github.com/lotabout/skim) binary installed +- [`neovim`](https://github.com/neovim/neovim/releases) version > `0.5.0` +- [`fzf`](https://github.com/junegunn/fzf) version > `0.27` (see note below) + **or** [`skim`](https://github.com/lotabout/skim) binary installed - [nvim-web-devicons](https://github.com/kyazdani42/nvim-web-devicons) (optional) +> `fzf` version > `0.27` is recommended but it's still possible to use `fzf` +> version > `0.24` by setting `fzf_opts = { ['--border'] = false }`, see +> [Customization](#customization). + ### Optional dependencies - [fd](https://github.com/sharkdp/fd) - better `find` utility @@ -246,7 +250,7 @@ vim.api.nvim_set_keymap('n', '', I tried to make it as customizable as possible, if you find you need to change something that isn’t below, open an issue and I’ll do my best to add it. -customization can be achieved by calling the `setup()` function or individually sending parameters to a builtin command, for exmaple: +customization can be achieved by calling the `setup()` function or individually sending parameters to a builtin command, for example: ```lua :lua require('fzf-lua').files({ fzf_opts = {['--layout'] = 'reverse-list'} }) ``` diff --git a/doc/fzf-lua.txt b/doc/fzf-lua.txt index d4b8d1c..f11cb9e 100644 --- a/doc/fzf-lua.txt +++ b/doc/fzf-lua.txt @@ -60,11 +60,15 @@ DEPENDENCIES *fzf-lua-dependencies* - `Linux` or `MacOS` -- `neovim` version > 0.5.0 -- `fzf` version > 0.24.0 **or** `skim` - binary installed +- `neovim` version > `0.5.0` +- `fzf` version > `0.27` (see note below) + **or** `skim` binary installed - nvim-web-devicons (optional) + `fzf` version > `0.27` is recommended but it's still possible to use `fzf` + version > `0.24` by setting `fzf_opts = { ['--border'] = false }`, see + Customization <#customization>. + OPTIONAL DEPENDENCIES *fzf-lua-optional-dependencies* @@ -290,7 +294,7 @@ I tried to make it as customizable as possible, if you find you need to change something that isn’t below, open an issue and I’ll do my best to add it. customization can be achieved by calling the `setup()` function or -individually sending parameters to a builtin command, for exmaple: +individually sending parameters to a builtin command, for example: > :lua require('fzf-lua').files({ fzf_opts = {['--layout'] = 'reverse-list'} })