Skip to content

Commit

Permalink
Updated readme to show that setup is required for plugin to work corr…
Browse files Browse the repository at this point in the history
…ectly.
  • Loading branch information
linguini1 committed Oct 20, 2023
1 parent 4026460 commit 5d5ef60
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@ for managing your timers.
Using [packer.nvim](https://github.com/wbthomason/packer.nvim)

```lua
use { "linguini1/pulse.nvim" }
use {
"linguini1/pulse.nvim",
config = function() require("pulse").setup() end -- Call setup to get the basic config
}
```

Using [lazy.nvim](https://github.com/folke/lazy.nvim)
Expand All @@ -26,9 +29,12 @@ Using [lazy.nvim](https://github.com/folke/lazy.nvim)
{
"linguini1/pulse.nvim",
version = "*", -- Latest stable release
config = function() require("pulse").setup() end -- Call setup to get the basic config
}
```

You must call `pulse.setup()` in order to get access to the editor commands and default functionality.

### Configuration

The configuration for pulse.nvim is very simple. Below is the default configuration. See `:h pulse.setup()` for more
Expand Down

0 comments on commit 5d5ef60

Please sign in to comment.