Skip to content

Latest commit

 

History

History
132 lines (93 loc) · 2.4 KB

README_TEMPLATE.md

File metadata and controls

132 lines (93 loc) · 2.4 KB
Raw

YOUR_REPOSITORY_NAME

> A catch phrase that describes your plugin.

> Drag your video (<10MB) here to host it for free on GitHub.

Videos don't work on GitHub mobile, so a GIF alternative can help users.

GIF version of the showcase video for mobile users

⚡️ Features

Write short sentences describing your plugin features

  • FEATURE 1
  • FEATURE ..
  • FEATURE N

📋 Installation

Package manager Snippet

wbthomason/packer.nvim

 
-- stable version
use {"YOUR_REPOSITORY_NAME", tag = "*" }
-- dev version
use {"YOUR_REPOSITORY_NAME"}

junegunn/vim-plug

 
-- stable version
Plug "YOUR_REPOSITORY_NAME", { "tag": "*" }
-- dev version
Plug "YOUR_REPOSITORY_NAME"

folke/lazy.nvim

 
-- stable version
require("lazy").setup({{"YOUR_REPOSITORY_NAME", version = "*"}})
-- dev version
require("lazy").setup({"YOUR_REPOSITORY_NAME"})

☄ Getting started

Describe how to use the plugin the simplest way

⚙ Configuration

The configuration list sometimes become cumbersome, making it folded by default reduce the noise of the README file.

Click to unfold the full list of options with their default values

Note: The options are also available in Neovim by calling :h your-plugin-name.options

require("your-plugin-name").setup({
    -- you can copy the full list from lua/your-plugin-name/config.lua
})

🧰 Commands

Command Description
:Toggle Enables the plugin.

⌨ Contributing

PRs and issues are always welcome. Make sure to provide as much context as possible when opening one.

🗞 Wiki

You can find guides and showcase of the plugin on the Wiki

🎭 Motivations

If alternatives of your plugin exist, you can provide some pros/cons of using yours over the others.