From eac03a05925d4f742229fe677f66f03857ab5b7e Mon Sep 17 00:00:00 2001 From: Stefan Rakel Date: Fri, 27 Oct 2023 11:02:08 +0200 Subject: [PATCH] Add more details to the readme --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a7eb801..6171755 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,24 @@ Parent and child items are updated automatically when a checkbox is changed. It is easily configurable what may come before the checkbox. Configuring what is skipped when searching for parents and child checkboxes alike is also possible. +## Installation + +Use your preferred plugin manager and add +``` +"ibutra/checkbox.nvim" +``` +as plugin. + ## Usage -See the documentation: [Vim Helpfile](doc/checkbox.nvim.txt) +Add a mapping to the provided function: + +```lua +vim.keymap.set("n", "x", require("checkbox").checkbox) +``` + +For further details and configuration options see the documentation: +[Vim Helpfile](doc/checkbox.nvim.txt) ## License