Skip to content

docs(readme): add lazy.nvim instructions #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
StikyPiston merged 1 commit into from
Feb 23, 2026
Merged

docs(readme): add lazy.nvim instructions #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

**Cheaty.nvim** allows you to create a configurable pop-up cheatsheet!

---

## Installation

### vim.pack
Expand All @@ -12,6 +14,17 @@ vim.pack.add({
})
```

### lazy.nvim

```lua
{
"stikypiston/cheaty.nvim",
opts = {},
}
```

---

## Configuration

You can write your cheatsheet in **Markdown**, to have some nice formatting.
Expand All @@ -29,4 +42,4 @@ require("cheaty").setup({
})
```

To invoke the cheatsheet, just run `:Cheaty`
To invoke the cheatsheet, just run `:Cheaty`.