Skip to content

Commit

Permalink
Update lazy.nvim instruction in README.md (#151)
Browse files Browse the repository at this point in the history
* Update lazy.nvim instruction in README.md

According to the documentation opts should be preferred instead of config.

* chore(docs): update configuration-options

---------

Co-authored-by: Marco Kellershoff <[email protected]>
  • Loading branch information
Elnee and gorillamoe authored Aug 17, 2024
1 parent 67bac82 commit 8afcc7c
Show file tree
Hide file tree
Showing 6 changed files with 177 additions and 142 deletions.
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,12 @@ Via [lazy.nvim](https://github.com/folke/lazy.nvim):
### Configuration

```lua
require('lazy').setup({
-- HTTP REST-Client Interface
{
'mistweaverco/kulala.nvim',
config = function()
-- Setup is required, even if you don't pass any options
require('kulala').setup()
end
},
})
{ 'mistweaverco/kulala.nvim', opts = {} },
```
> [!NOTE]
> `opts` needs to be at least an empty table `{}` and can't be completely omitted.
See [setup options](https://kulala.mwco.app/docs/getting-started/setup-options) for more information.
See [configuration options](https://kulala.mwco.app/docs/getting-started/configuration-options) for more information.

## Honorable mentions

Expand Down
Loading

0 comments on commit 8afcc7c

Please sign in to comment.