From 4ea6f9b7aba3039dec153ebd7c0f1c3bb7fd8c4f Mon Sep 17 00:00:00 2001
From: Stephen Seo <seo.disparate@gmail.com>
Date: Thu, 3 Nov 2022 11:33:54 +0900
Subject: [PATCH] Add README.md

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 README.md

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()<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>