Skip to content

Commit

Permalink
docs: update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
2KAbhishek committed Nov 10, 2024
1 parent 04e3405 commit 6a84c35
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,6 @@ template.nvim is a neovim plugin that allows neovim users to `<action>`.
-- Lazy
{
'2kabhishek/template.nvim',
dependencies = {
'nvim-lua/plenary.nvim'
},
cmd = 'TemplateHello',
},

Expand All @@ -68,11 +65,11 @@ use '2kabhishek/template.nvim'
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_spec.lua) file
- Code entrypoint is [template.lua](./lua/template.lua)
- Add user configs to [config.lua](./lua/template/config.lua)
- For adding commands and keybindngs use [commands.lua](./lua/template/commands.lua)
- Separate plugin logic into modules under [modules](./lua/template/) dir
4. Add test code to the [tests](./tests/) directory
5. Update the README
6. Tweak the [docs action](./.github/workflows/docs.yml) file to reflect your username, commit message and plugin name

Expand Down Expand Up @@ -104,7 +101,7 @@ It is recommended to use:
### Help

Run `:help nerdy` for more details.
Run `:help template.txt` for more details.

## 🏗️ What's Next

Expand Down

0 comments on commit 6a84c35

Please sign in to comment.