From cdb24878258f9b7b03deacc653eb23c51ac47253 Mon Sep 17 00:00:00 2001 From: Abhishek Keshri Date: Wed, 25 Sep 2024 18:22:18 +0530 Subject: [PATCH] docs: add usage instructions --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a3d3478..d3d5579 100644 --- a/README.md +++ b/README.md @@ -40,8 +40,6 @@ template.nvim is a neovim plugin that allows neovim users to ``. - Comes with a ready to go README template - Works with [mkrepo](https://github.com/2kabhishek/mkrepo) -> Generating vimdocs needs write access to actions (repo settings > actions > general > workflow permissions) - ## ⚡ Setup ### ⚙️ Requirements @@ -67,6 +65,17 @@ use '2kabhishek/template.nvim' ## 🚀 Usage +1. Fork the `template.nvim` repo +2. Update the plugin name, file names etc, change `template` to `your-plugin-name` +3. Add the code required for your plugin, + - Main logic, config options for the plugin code goes into [lua/template](./lua/template.lua) + - Supporting code goes into [lua/modules](./lua/template/) if needed + - For adding commands and keybindngs use [plugin/template](./plugin/template.lua) +4. Add test code to the [tests](./tests/template) directory +5. Update the README +6. Tweak the [docs action](./.github/workflows/docs.yml) file to reflect your username, commit message and plugin name + - Generating vimdocs needs write access to actions (repo settings > actions > general > workflow permissions) + ### Configuration template.nvim can be configured using the following options: