From 3bece973c5d80e7da447157822d5b0e73558d361 Mon Sep 17 00:00:00 2001 From: James Trew <66286082+jamestrew@users.noreply.github.com> Date: Tue, 19 Mar 2024 22:22:36 -0400 Subject: [PATCH] docs(readme): add neovim minimum version (#369) Need 0.9.0 or higher for `vim.fs` access. --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 7b50ba54..b4d9e858 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ More demo examples can be found in the [showcase issue](https://github.com/nvim- ### Table of Contents +- [Requirements](#requirements) - [Installation](#installation) - [Setup and Configuration](#setup-and-configuration) - [Usage](#usage) @@ -20,22 +21,27 @@ More demo examples can be found in the [showcase issue](https://github.com/nvim- --- +## Requirements +- Neovim >= **0.9.0** +- [fd](https://github.com/sharkdp/fd) (optional, for faster browser) +- git (optional, for display git status) + ## Installation Install the plugin with your preferred package manager. ```lua --- packer -use { - "nvim-telescope/telescope-file-browser.nvim", - requires = { "nvim-telescope/telescope.nvim", "nvim-lua/plenary.nvim" } -} - --lazy { "nvim-telescope/telescope-file-browser.nvim", dependencies = { "nvim-telescope/telescope.nvim", "nvim-lua/plenary.nvim" } } + +-- packer +use { + "nvim-telescope/telescope-file-browser.nvim", + requires = { "nvim-telescope/telescope.nvim", "nvim-lua/plenary.nvim" } +} ```
@@ -49,12 +55,6 @@ Plug 'nvim-telescope/telescope-file-browser.nvim'
-#### Optional Dependencies - -- `telescope-file-browser` optionally leverages [fd](https://github.com/sharkdp/fd) if installed for faster, more async browsing -- [`nvim-web-devicons`](https://github.com/nvim-tree/nvim-web-devicons) for file icons -- `git` to show the status of files directly in the file browser. - ## Setup and Configuration You can configure the `telescope-file-browser` like any other `telescope.nvim` picker. Please see `:h telescope-file-browser.picker` for the full set of options dedicated to the picker. Unless otherwise stated, you can pass these options either to your configuration at extension setup or picker startup. For instance, you can map `theme` and [mappings](#remappings) as you are used to from `telescope.nvim`.