https://github.com/linguini1/pulse.nvim

A simple timer plugin for Neovim.
https://github.com/linguini1/pulse.nvim

lua neovim neovim-plugin neovim-plugins productivity productivity-tools timer

Last synced: 21 days ago
JSON representation

A simple timer plugin for Neovim.

• Host: GitHub
• URL: https://github.com/linguini1/pulse.nvim
• Owner: linguini1
• License: gpl-3.0
• Created: 2023-08-23T19:08:05.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-25T19:44:00.000Z (about 1 year ago)
• Last Synced: 2024-10-18T05:21:27.572Z (about 1 month ago)
• Topics: lua, neovim, neovim-plugin, neovim-plugins, productivity, productivity-tools, timer
• Language: Lua
• Homepage:
• Size: 68.4 KB
• Stars: 23
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    


        

        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](https://github.com/nvim-telescope/telescope.nvim) installed, pulse will also make use of its features

for managing your timers.

## Getting Started

### Installation

Using [packer.nvim](https://github.com/wbthomason/packer.nvim)

```lua

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)

```lua

{

    "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.

```lua

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.

```lua

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](https://github.com/mvllow/stand.nvim), a plugin which reminds you to stand.