diff --git a/doc/kitty-scrollback.nvim.txt b/doc/kitty-scrollback.nvim.txt index bd77439c..e77c7d45 100644 --- a/doc/kitty-scrollback.nvim.txt +++ b/doc/kitty-scrollback.nvim.txt @@ -4,6 +4,7 @@ Table of Contents *kitty-scrollback.nvim-table-of-contents* 1. kitty-scrollback.nvim |kitty-scrollback.nvim-kitty-scrollback.nvim| + - Migrating to v2.0.0 |kitty-scrollback.nvim-migrating-to-v2.0.0| - Features |kitty-scrollback.nvim-features| - Example use cases |kitty-scrollback.nvim-example-use-cases| - Prerequisites |kitty-scrollback.nvim-prerequisites| @@ -25,6 +26,23 @@ Navigate your Kitty scrollback buffer to quickly search, copy, and execute commands in Neovim. +MIGRATING TO V2.0.0 *kitty-scrollback.nvim-migrating-to-v2.0.0* + + + `IMPORTANT` v2.0.0 has breaking changes and requires steps to properly migrate + from previous versions. + You can ignore this section if you have not previously installed any verions of + kitty-scrollback.nvim +- Migration Steps +- If you are using the packer.nvim + package manager, then add the custom `User` event `KittyScrollbackLaunch` as a + trigger for lazy loading. See |kitty-scrollback.nvim-installation| for + additional details. + >lua + event = { 'User KittyScrollbackLaunch' } + < + + FEATURES *kitty-scrollback.nvim-features* - Navigate Kitty’s scrollback buffer with Neovim