diff --git a/README.md b/README.md index 16d5cd5..521edca 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ # nvim-plugin-template Neovim plugin template; includes automatic documentation generation from README, integration tests with Busted, and linting with Stylua +yeah ## Usage 1. Click `use this template` button generate a repo on your github. 2. Clone your plugin repo. Open terminal then cd plugin directory. -3. Run `python3 rename.py your-plugin-name`. This will replace all `nvim-plugin-template` to your `plugin-name`. +3. Run `python3 rename.py your-plugin-name`. This will replace all `nvim-plugin-template` to your `plugin-name`. Then it will prompt you input `y` or `n` to remove example codes in `init.lua` and `test/plugin_spec.lua`. If you are familiar this repo just input `y`. If you are looking at this template for the first time I suggest you inspect the contents. After this step `rename.py` will also auto-remove.