Skip to content
This repository was archived by the owner on Nov 30, 2025. It is now read-only.

Commit 557f7f4

Browse files
committed
chore(doc): update readme
1 parent aeec296 commit 557f7f4

1 file changed

Lines changed: 8 additions & 45 deletions

File tree

README.md

Lines changed: 8 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,10 @@
1-
# A Neovim Plugin Template
1+
# :coffee: nvim-java-test
22

3-
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ellisonleao/nvim-plugin-template/lint-test.yml?branch=main&style=for-the-badge)
4-
![Lua](https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua)
3+
![Neovim](https://img.shields.io/badge/NeoVim-%2357A143.svg?&style=for-the-badge&logo=neovim&logoColor=white)
4+
![Lua](https://img.shields.io/badge/lua-%232C2D72.svg?style=for-the-badge&logo=lua&logoColor=white)
5+
![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white)
6+
![Gradle](https://img.shields.io/badge/Gradle-02303A.svg?style=for-the-badge&logo=Gradle&logoColor=white)
7+
![Apache Maven](https://img.shields.io/badge/Apache%20Maven-C71A36?style=for-the-badge&logo=Apache%20Maven&logoColor=white)
58

6-
A template repository for Neovim plugins.
7-
8-
## Using it
9-
10-
Via `gh`:
11-
12-
```
13-
$ gh repo create my-plugin -p ellisonleao/nvim-plugin-template
14-
```
15-
16-
Via github web page:
17-
18-
Click on `Use this template`
19-
20-
![](https://docs.github.com/assets/cb-36544/images/help/repository/use-this-template-button.png)
21-
22-
## Features and structure
23-
24-
- 100% Lua
25-
- Github actions for:
26-
- running tests using [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) and [busted](https://olivinelabs.com/busted/)
27-
- check for formatting errors (Stylua)
28-
- vimdocs autogeneration from README.md file
29-
- luarocks release (LUAROCKS_API_KEY secret configuration required)
30-
31-
### Plugin structure
32-
33-
```
34-
.
35-
├── lua
36-
│   ├── plugin_name
37-
│   │   └── module.lua
38-
│   └── plugin_name.lua
39-
├── Makefile
40-
├── plugin
41-
│   └── plugin_name.lua
42-
├── README.md
43-
├── tests
44-
│   ├── minimal_init.lua
45-
│   └── plugin_name
46-
│   └── plugin_name_spec.lua
47-
```
9+
This is a sub project of [nvim-java](https://github.com/nvim-java/nvim-java). Please refer the
10+
[README](https://github.com/nvim-java/nvim-java) in the main repository.

0 commit comments

Comments
 (0)