Skip to content

Commit 66c4298

Browse files
docs(README): added usage and keymaps sections
1 parent d612c37 commit 66c4298

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,24 @@ are any problems with the installation or you need to install additional tools.
105105
(<a href="#readme-top">Back to top</a>)
106106
</div>
107107

108+
## Usage
109+
110+
To use this plugin, simply call `:Freeze` and it will take a screenshot of the
111+
current buffer and save it in the `dir` path you have configured.
112+
113+
If you want to take a screenshot of a specific line, you can use the `:Freeze` in
114+
visual mode, and it will take a screenshot of the selected lines.
115+
116+
### Keymaps
117+
118+
```lua
119+
vim.keymap.set("n", "<leader>fz", require("freeze-code").freeze)
120+
vim.keymap.set("v", "<leader>fz", function()
121+
require("freeze-code").freeze(vim.fn.line("'<"), vim.fn.line("'>"))
122+
end)
123+
-- or using `<cmd>Freeze<cr>`
124+
```
125+
108126
## Contributing
109127

110128
Thank you to everyone that is contributing and to those who want to contribute.

0 commit comments

Comments
 (0)