Skip to content

Commit

Permalink
docs(readme): add neovim minimum version (#369)
Browse files Browse the repository at this point in the history
Need 0.9.0 or higher for `vim.fs` access.
  • Loading branch information
jamestrew committed Mar 20, 2024
1 parent 9e913ac commit 3bece97
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Expand Up @@ -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)
Expand All @@ -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" }
}
```

<details>
Expand All @@ -49,12 +55,6 @@ Plug 'nvim-telescope/telescope-file-browser.nvim'

</details>

#### 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`.
Expand Down

0 comments on commit 3bece97

Please sign in to comment.