Skip to content

Commit

Permalink
Add installation section to README (#164)
Browse files Browse the repository at this point in the history
  • Loading branch information
myarcana authored Nov 19, 2024
1 parent 34dfa6d commit 7dea0d3
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,34 @@ that allows you to switch between projects.
- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) (required)
- [telescope-file-browser.nvim](https://github.com/nvim-telescope/telescope-file-browser.nvim) (optional, only for `file_browser` action)

## Installation

### Lazy.nvim

```lua
{
'nvim-telescope/telescope-project.nvim',
dependencies = {
'nvim-telescope/telescope.nvim',
},
}
```

### packer.nvim

```lua
use {
'nvim-telescope/telescope-project.nvim',
requires = {
'nvim-telescope/telescope.nvim',
},
}
```


## Setup

You can setup the extension by adding the following to your config:
You can set up the extension by adding the following to your config:

```lua
require'telescope'.load_extension('project')
Expand Down

0 comments on commit 7dea0d3

Please sign in to comment.