docs: improve README.md
parent
81ab0beacd
commit
bb05f09bec
28
README.md
28
README.md
|
@ -27,20 +27,20 @@
|
||||||
## Usage
|
## Usage
|
||||||
See also [lazy.nvim](https://github.com/folke/lazy.nvim/#-plugin-spec) plugin spec.
|
See also [lazy.nvim](https://github.com/folke/lazy.nvim/#-plugin-spec) plugin spec.
|
||||||
|
|
||||||
| Property | Type | Description |
|
| Property | Type | Description |
|
||||||
|----------|------|-------------|
|
|-------------|------------|------------------------------------------------------------------------------------------------------|
|
||||||
| plugin | derivation | The plugins vimPlugin derivation. |
|
| plugin | derivation | The plugins vimPlugin derivation. |
|
||||||
| lazy | bool | Like [lazy.nvim](https://github.com/folke/lazy.nvim/#-plugin-spec). |
|
| lazy | bool | Like [lazy.nvim](https://github.com/folke/lazy.nvim/#-plugin-spec). |
|
||||||
| enabled | bool | Like [lazy.nvim](https://github.com/folke/lazy.nvim/#-plugin-spec) |
|
| enabled | bool | Like [lazy.nvim](https://github.com/folke/lazy.nvim/#-plugin-spec) |
|
||||||
| dependecies | list attrset | List of plugin definitions. |
|
| dependecies | [attrset] | List of plugin definitions. |
|
||||||
| init | str | Lua code to run on startup. |
|
| init | str | Lua code to run on startup. |
|
||||||
| opts | attrset | Attrset of primitive types (str, bool, int, float, list, attrset) which gets transformed into lua |
|
| opts | attrset | Attrset of primitive types (str, bool, int, float, list, attrset) which gets transformed into lua |
|
||||||
| conf | str | Lua code. Like config function body in [lazy.nvim](https://github.com/folke/lazy.nvim/#-plugin-spec) |
|
| conf | str | Lua code. Like config function body in [lazy.nvim](https://github.com/folke/lazy.nvim/#-plugin-spec) |
|
||||||
| event | list str | List of event names to lazy load on. |
|
| event | [str] | List of event names to lazy load on. |
|
||||||
| cmd | list str | List of commands to lazy load on. |
|
| cmd | [str] | List of commands to lazy load on. |
|
||||||
| ft | list str | List of filetypes to lazy load on. |
|
| ft | [str] | List of filetypes to lazy load on. |
|
||||||
| keys | attrset | See [Example](#example) |
|
| keys | attrset | See [Example](#example) |
|
||||||
| priority | int | Like [lazy.nvim](https://github.com/folke/lazy.nvim/#-plugin-spec) |
|
| priority | int | Like [lazy.nvim](https://github.com/folke/lazy.nvim/#-plugin-spec) |
|
||||||
|
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
Loading…
Reference in New Issue