Skip to content

Commit 3011771

Browse files
authored
Merge pull request #6 from DrKJeff16/docs/readme
docs(readme): add `lazy.nvim` instructions
2 parents b0f3bfb + 56b30eb commit 3011771

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

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

5+
---
6+
57
## Installation
68

79
### vim.pack
@@ -12,6 +14,17 @@ vim.pack.add({
1214
})
1315
```
1416

17+
### lazy.nvim
18+
19+
```lua
20+
{
21+
"stikypiston/cheaty.nvim",
22+
opts = {},
23+
}
24+
```
25+
26+
---
27+
1528
## Configuration
1629

1730
You can write your cheatsheet in **Markdown**, to have some nice formatting.
@@ -30,4 +43,4 @@ require("cheaty").setup({
3043
})
3144
```
3245

33-
To invoke the cheatsheet, just run `:Cheaty`
46+
To invoke the cheatsheet, just run `:Cheaty`.

0 commit comments

Comments
 (0)