Skip to content

Commit

Permalink
docs: add note for dropping support for 0.9.x
Browse files Browse the repository at this point in the history
  • Loading branch information
delphinus committed Dec 10, 2024
1 parent f289990 commit de5a93a
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,10 @@ If the active buffer (prior to the finder being launched) is attached to an LSP
server, an automatic `LSP` tag is available, which maps to the workspace
directories provided by the language server.


## Requirements

* Neovim v0.10.0 or higher
* Use `v0.9.0` tag for Neovim 0.9.x (See [Notice for versioning](#notice-for-versioning)).
- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) **(required)**
- [nvim-web-devicons](https://github.com/kyazdani42/nvim-web-devicons) (optional)
- [fd](https://github.com/sharkdp/fd) or [ripgrep](https://github.com/BurntSushi/ripgrep) (optional)
Expand All @@ -76,6 +77,22 @@ This is an example for [Lazy.nvim](https://github.com/folke/lazy.nvim).

See `:h telescope-frecency-configuration` to know about further configurations.

### Notice for versioning

A tagged release `v1.0.0` is published and it drops the support for Neovim 0.9.x.
If you are still using Neovim 0.9.x, use `v0.9.0` tag for your favorite plugin
manager.

```lua
{
"nvim-telescope/telescope-frecency.nvim",
tag = "v0.9.0",
config = function()
require("telescope").load_extension "frecency"
end,
}
```

## Usage

```vim
Expand Down
16 changes: 16 additions & 0 deletions doc/telescope-frecency.txt
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ You can define other workspace tags by an option:
==============================================================================
REQUIREMENTS *telescope-frecency-requirements*

- Neovim 0.10.0 or higher
- |telescope.nvim| (required)
https://github.com/nvim-telescope/telescope.nvim
- nvim-web-devicons (optional)
Expand Down Expand Up @@ -145,6 +146,21 @@ imported.
NOTE: Even if you want to load |telescope.nvim| lazily, you should NOT load
telescope-frecency.nvim lazily. See |telescope-frecency-function-setup|.

------------------------------------------------------------------------------
Notice for versioning

A tagged release `v1.0.0` is published and it drops the support for Neovim
0.9.x. If you are still using Neovim 0.9.x, use `v0.9.0` tag for your favorite
plugin manager.
>lua
-- for lazy.nvim
{
"nvim-telescope/telescope-frecency.nvim",
tag = "v0.9.0",
config = function()
require("telescope").load_extension "frecency"
end,
}

==============================================================================
USAGE *telescope-frecency-usage*
Expand Down

0 comments on commit de5a93a

Please sign in to comment.