From 2f8ff9728cb1f652b2932fb2db48f7b9776ad63e Mon Sep 17 00:00:00 2001 From: delphinus Date: Tue, 10 Dec 2024 15:15:14 +0900 Subject: [PATCH] docs: add note for dropping support for 0.9.x --- README.md | 22 +++++++++++++++++++++- doc/telescope-frecency.txt | 19 +++++++++++++++++++ 2 files changed, 40 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f678583..c7a18c2 100644 --- a/README.md +++ b/README.md @@ -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) @@ -68,6 +69,8 @@ This is an example for [Lazy.nvim](https://github.com/folke/lazy.nvim). ```lua { "nvim-telescope/telescope-frecency.nvim", + -- install the latest stable version + version = "*", config = function() require("telescope").load_extension "frecency" end, @@ -76,6 +79,23 @@ 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 `1.0.0` is published and it drops the support for Neovim 0.9.x. +If you are still using Neovim 0.9.x, use `0.9.0` tag for your favorite plugin +manager. + +```lua +{ + "nvim-telescope/telescope-frecency.nvim", + -- install any compatible version of 0.9.x + version = "^0.9.0", + config = function() + require("telescope").load_extension "frecency" + end, +} +``` + ## Usage ```vim diff --git a/doc/telescope-frecency.txt b/doc/telescope-frecency.txt index 49087b6..cdf2bf1 100644 --- a/doc/telescope-frecency.txt +++ b/doc/telescope-frecency.txt @@ -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) @@ -133,6 +134,8 @@ lazy.nvim: https://github.com/folke/lazy.nvim -- for lazy.nvim { "nvim-telescope/telescope-frecency.nvim", + -- install the latest stable version + version = "*", config = function() require("telescope").load_extension "frecency" end, @@ -145,6 +148,22 @@ 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", + -- install any compatible version of 0.9.x + version = "^0.9.0", + config = function() + require("telescope").load_extension "frecency" + end, + } ============================================================================== USAGE *telescope-frecency-usage*