https://github.com/mgastonportillo/yerbreak.nvim

🧉 You deserve a yerbreak
https://github.com/mgastonportillo/yerbreak.nvim

Last synced: 2 days ago
JSON representation

🧉 You deserve a yerbreak

• Host: GitHub
• URL: https://github.com/mgastonportillo/yerbreak.nvim
• Owner: mgastonportillo
• Created: 2024-04-26T02:26:11.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-21T06:29:10.000Z (7 months ago)
• Last Synced: 2024-05-21T07:43:38.340Z (7 months ago)
• Language: Lua
• Homepage:
• Size: 51.8 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🧉 Yerbreak

https://github.com/mgastonportillo/yerbreak.nvim/assets/106234166/fd992095-2212-4e33-bbd6-c5afd4049463

> Make a pause, take a deep breath and drink some mates. Now you're ready to get back to work.

## Installation

Lazy:

```lua

{

  "mgastonportillo/yerbreak.nvim",

  dependencies = { "rcarriga/nvim-notify" }, -- optional: custom notifications

  event = "VeryLazy",

  init = function()

    -- any mappings should go here

  end

  opts = {}, -- or config = true

}

```

## Configuration

Defaults:

```lua

opts = {

  ascii_table = "mate" -- "mate" | "op"

  delay = 200, -- integer (ms)

  border = "rounded", -- "rounded" | "single" | "none" | "double" | "solid" | "shadow"

}

```

## Commands

`:Yerbreak` Toggle Yerbreak on/off

## Credits

`@MaximilianLloyd` for the One Piece ascii tables