From 5d5ef608326a8574584da5b72c3de42e26dc01d4 Mon Sep 17 00:00:00 2001 From: Matteo Golin Date: Thu, 19 Oct 2023 21:58:46 -0400 Subject: [PATCH] Updated readme to show that setup is required for plugin to work correctly. --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 193e788..12f1d6f 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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