Add README.md

2022-11-03 11:33:54 +09:00 · 2022-11-03 11:33:54 +09:00 · 4ea6f9b7ab
parent e39309a42e
commit 4ea6f9b7ab
1 changed files with 13 additions and 0 deletions
--- a/README.md
+++ 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()<CR>')
+    vim.cmd('vmap q :luado vim.g.quickcomment_togglecommentline(linenr)<CR>')
+
+Or in init.vim:
+
+    nmap q :lua vim.g.quickcomment_togglecommentline()<CR>
+    vmap q :luado vim.g.quickcomment_togglecommentline(linenr)<CR>