Skip to content

Commit a659d8b

Browse files
committed
update
1 parent 1709845 commit a659d8b

File tree

8 files changed

+624
-155
lines changed

8 files changed

+624
-155
lines changed

README.md

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,20 @@
1-
# nvim-plugin-template
1+
# Phoenix
22

3-
Neovim plugin template; includes automatic documentation generation from README, integration tests with Busted, and linting with Stylua
3+
A blazing-fast asynchronous in-process server providing word and path completion.
44

5-
## Usage
6-
7-
1. Click `use this template` button generate a repo on your github.
8-
2. Clone your plugin repo. Open terminal then cd plugin directory.
9-
3. Run `python3 rename.py your-plugin-name`. This will replace all `nvim-plugin-template` to your `plugin-name`.
10-
Then it will prompt you input `y` or `n` to remove example codes in `init.lua` and
11-
`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.
12-
13-
Now you have a clean plugin environment. Enjoy!
14-
15-
## Format
5+
## How fast it is ?
166

17-
The CI uses `stylua` to format the code; customize the formatting by editing `.stylua.toml`.
7+
It enables smooth word completion in nearly 10,000 lines of text and provides
8+
instant completion in projects with thousands of files.
189

19-
## Test
10+
![Image](https://github.com/user-attachments/assets/ec81041b-7f37-4613-ad91-419a76ee2eeb)
2011

21-
See [Running tests locally](https://github.com/nvim-neorocks/nvim-busted-action?tab=readme-ov-file#running-tests-locally)
22-
23-
## CI
24-
25-
- Auto generates doc from README.
26-
- Runs the [nvim-busted-action](https://github.com/nvim-neorocks/nvim-busted-action) for test.
27-
- Lints with `stylua`.
12+
## Usage
2813

29-
## More
14+
```lua
15+
require('phoenix').setup()
16+
```
3017

31-
To see this template in action, take a look at my other plugins.
18+
all config in `vim.g.phoenix` option table
3219

3320
## License MIT

doc/guard.nvim.txt

Lines changed: 0 additions & 60 deletions
This file was deleted.

lua/nvim-plugin-template/init.lua

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)