Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jtubbenhauer authored Nov 14, 2023
1 parent 02e8591 commit 4510029
Showing 1 changed file with 5 additions and 39 deletions.
44 changes: 5 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,13 @@
# A Neovim Plugin Template
# selfhelp.nvim

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ellisonleao/nvim-plugin-template/lint-test.yml?branch=main&style=for-the-badge)
![Lua](https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua)

A template repository for Neovim plugins.
A simple Neovim plugin to display a floating help dialog displaying your key mappings

## Using it

Via `gh`:

```
$ gh repo create my-plugin -p ellisonleao/nvim-plugin-template
```

Via github web page:

Click on `Use this template`

![](https://docs.github.com/assets/cb-36544/images/help/repository/use-this-template-button.png)

## Features and structure

- 100% Lua
- Github actions for:
- running tests using [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) and [busted](https://olivinelabs.com/busted/)
- check for formatting errors (Stylua)
- vimdocs autogeneration from README.md file
- luarocks release (LUAROCKS_API_KEY secret configuration required)

### Plugin structure
## Installation

Lazy.nvim
```
.
├── lua
│   ├── plugin_name
│   │   └── module.lua
│   └── plugin_name.lua
├── Makefile
├── plugin
│   └── plugin_name.lua
├── README.md
├── tests
│   ├── minimal_init.lua
│   └── plugin_name
│   └── plugin_name_spec.lua
{ 'jtubbenhauer/selfhelp.nvim' }
```

0 comments on commit 4510029

Please sign in to comment.