Skip to content

Commit

Permalink
docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mikesmithgh authored Nov 1, 2023
1 parent 5e33951 commit 499691f
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,27 @@ Navigate your Kitty scrollback buffer to quickly search, copy, and execute comma

<!-- panvimdoc-ignore-end -->

## 🚀 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
<details>

<summary>Migration Steps</summary>

- If you are using the <a href="https://github.com/folke/lazy.nvim">lazy.nvim</a> or <a href="https://github.com/wbthomason/packer.nvim">packer.nvim</a> package manager, then
add the custom `User` event `KittyScrollbackLaunch` as a trigger for lazy loading. See [Installation](#-installation) for additional details.

```lua
event = { 'User KittyScrollbackLaunch' }
```

</details>



##Features
- 😻 Navigate Kitty's scrollback buffer with Neovim
- 🐱 Copy contents from Neovim to system clipboard
Expand Down

0 comments on commit 499691f

Please sign in to comment.