Skip to content

Commit

Permalink
docs: add usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
2KAbhishek committed Sep 25, 2024
1 parent 1bcc1dc commit cdb2487
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,6 @@ template.nvim is a neovim plugin that allows neovim users to `<action>`.
- 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
Expand All @@ -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:
Expand Down

0 comments on commit cdb2487

Please sign in to comment.