diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6e92f57 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +tags diff --git a/README.md b/README.md new file mode 100644 index 0000000..a7eb801 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# checkbox.nvim + +## Introduction + +This plugin provides an easy way to toggle nested checkboxes of the form: +```markdown + [ ] item + * [ ] item + - [X] item +``` +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. + +## Usage + +See the documentation: [Vim Helpfile](doc/checkbox.nvim.txt) + +## License + +``` +MIT License + +Copyright (c) 2023 Stefan Rakel + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +``` diff --git a/doc/tags b/doc/tags deleted file mode 100644 index a8a27aa..0000000 --- a/doc/tags +++ /dev/null @@ -1,8 +0,0 @@ -checkbox-changelog checkbox.nvim.txt /*checkbox-changelog* -checkbox-configuration checkbox.nvim.txt /*checkbox-configuration* -checkbox-introduction checkbox.nvim.txt /*checkbox-introduction* -checkbox-license checkbox.nvim.txt /*checkbox-license* -checkbox-prefixPatterns checkbox.nvim.txt /*checkbox-prefixPatterns* -checkbox-skipPatterns checkbox.nvim.txt /*checkbox-skipPatterns* -checkbox-usage checkbox.nvim.txt /*checkbox-usage* -checkbox.nvim.txt checkbox.nvim.txt /*checkbox.nvim.txt*