From 8ec4b1c0740db4c8589fa25f27f0e2d346411a1e Mon Sep 17 00:00:00 2001 From: Sadik Saifi Date: Sat, 10 Jun 2023 00:56:21 +0530 Subject: [PATCH] docs(plugin): add docs for installing comment.nvim with lazy.nvim --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 6aa7bd1c..118599ed 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,21 @@ ### 🚀 Installation +- With [lazy.nvim](https://github.com/folke/lazy.nvim) + +```lua +return { + 'numToStr/Comment.nvim', + keys = { -- example keymaps for lazy loading this plugin. + { "gcc", mode = "n", desc = "Toggles the current line using linewise comment" }, + { "gbc", mode = "n", desc = "Toggles the current line using blockwise comment" }, + { "gc", mode = "v", desc = "Toggles the region using linewise comment" }, + { "gb", mode = "v", desc = "Toggles the region using blockwise comment" }, + }, + opts = {} -- lazy equivalent to setup({}) function +} +``` + - With [packer.nvim](https://github.com/wbthomason/packer.nvim) ```lua