diff --git a/README.md b/README.md new file mode 100644 index 0000000..1d3ea99 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# NVim QuickComment + +## Usage + +Add the following to your init.lua (replace "q" with the key you want to map to): + + vim.cmd('nmap q :lua vim.g.quickcomment_togglecommentline()') + vim.cmd('vmap q :luado vim.g.quickcomment_togglecommentline(linenr)') + +Or in init.vim: + + nmap q :lua vim.g.quickcomment_togglecommentline() + vmap q :luado vim.g.quickcomment_togglecommentline(linenr)