https://github.com/cmpadden/pomodoro.nvim
Neovim plugin to follow the Pomodoro Technique
https://github.com/cmpadden/pomodoro.nvim
Last synced: 8 months ago
JSON representation
Neovim plugin to follow the Pomodoro Technique
- Host: GitHub
- URL: https://github.com/cmpadden/pomodoro.nvim
- Owner: cmpadden
- Created: 2022-09-25T20:59:20.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-26T23:53:46.000Z (over 3 years ago)
- Last Synced: 2025-02-05T23:25:06.153Z (over 1 year ago)
- Language: Lua
- Size: 11.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Break your workflow into regular work-and-break intervals following the [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique).
# Installation
## vim-plug
```vim
Plug 'cmpadden/pomodoro.nvim'
```
## [Packer](https://github.com/wbthomason/packer.nvim)
```lua
use { "cmpadden/pomodoro.nvim" }
```
# Setup
```lua
require("pomodoro").setup()
```
## Usage
The default keybinding to display the pomodoro pop-up is `p`.
Here, you can use pre-defined bindings to start, pause, or skip a pomodoro work or break interval.
Once a work interval has completed, the pop-up will automatically be displayed to inform you that it's break time!
## Motivation
Having recently migrated my personal Neovim configuration files to use Lua, I was looking for an excuse to explore Lua, the programming language, and the Lua Neovim bindings.
Feedback is definitely welcome in this repository, as the primary objective of writing this plugin was to learn!