Skip to content

Commit 4580eac

Browse files
authored
docs: updates README.md
Adds a banner and an allowed regexp pattern for presets' names.
1 parent 23dfd56 commit 4580eac

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
<h1 align="center">reactive.nvim</h1>
22
<p align="center"><sup>Reactivity. Right in your neovim.</sup></p>
33

4+
![reactive](https://github.com/rasulomaroff/reactive.nvim/assets/80093436/42565d8a-68d1-4bee-832b-7c5e379dbe01)
5+
46
<div align="center">
57
<img src="https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua">
68
<img src="https://img.shields.io/github/stars/rasulomaroff/reactive.nvim?style=for-the-badge">
@@ -192,7 +194,7 @@ The `name` field is required.
192194

193195
| Property | Type | Description |
194196
|-----------|-----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
195-
| name | `string` | This is your preset's name. It should be unique across other presets. |
197+
| name | `string` | This is your preset's name. It should be unique across other presets. Regexp pattern: `[a-zA-Z0-9_-]`. |
196198
| lazy | `boolean` | This property is meant to be used by other plugin developers. By making your preset lazy you can delay its usage till a user decides to activate it. |
197199
| priority | `number` | You can set a priority of any preset, if you faced conflicting preset highlights, for example. It's not recommended to set this field, if you are a plugin developer. |
198200
| skip | `fun(): boolean` or `{ winhl?: fun(): boolean, hl?: fun(): boolean }` | This function will be called on every mode change, so that you can define when your preset shouldn't be applied. It should return true, if you want to skip applying highlights. You can also pass a table with functions, if you want to disable only window highlights or highlights. |

0 commit comments

Comments
 (0)