Skip to content

linguini1/pulse.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pulse.nvim

Easily manageable timers to keep on track while coding.

Pulse.nvim is a plugin for creating and managing personal timers. If you have telescope.nvim installed, pulse will also make use of its features for managing your timers.

Getting Started

Installation

Using packer.nvim

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

Using 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 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 information.

local pulse = require("pulse")
--- Default configuration settings
pulse.setup({
    level = vim.log.levels.INFO,
})

Once you have setup pulse.nvim, you can add timers using the below format. See :h pulse.add() for more information.

local pulse = require("pulse")
pulse.setup()
pulse.add("break-timer", {
    interval = 60,
    message = "Take a break!",
    enabled = true
})

Documentation

See :h pulse.nvim for documentation.

Attribution

This plugin was inspired by stand.nvim, a plugin which reminds you to stand.