Skip to content

Commit

Permalink
docs(readme): update README
Browse files Browse the repository at this point in the history
  • Loading branch information
NStefan002 committed May 30, 2024
1 parent 0c7b672 commit 9e0b902
Showing 1 changed file with 34 additions and 30 deletions.
64 changes: 34 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,64 +9,68 @@ and after you press any key it restores your buffers.

## 📺 Showcase


https://github.com/NStefan002/donut.nvim/assets/100767853/f1b538ff-e0a8-4aac-b33b-8392f12b4bae

## 📋 Installation

> [!NOTE]
>
> - Neovim version >= 0.9.5 is required.
> - No need to call `setup` function, donut.nvim is ready to use out of the box.
> - Only call `setup` function if you want to change the default configuration.
> - No need to lazy load it via Lazy.nvim, donut.nvim lazy loads by default.
## 📋 Installation

[lazy](https://github.com/folke/lazy.nvim):

```lua
{
"NStefan002/donut.nvim",
event = "VeryLazy",
opts = {
-- your config
},
version = "*",
lazy = false,
}
```

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

```lua
use({
"NStefan002/donut.nvim",
config = function()
require("donut").setup({
-- your config
})
end,
})
```

[rocks.nvim](https://github.com/nvim-neorocks/rocks.nvim):

`:Rocks install donut.nvim`

### Configuration
## ⚙️ Configuration

<details>
<summary>Full list of options:</summary>
<summary>Default configuration</summary>

```lua
{
timeout = 60,
timeout = 300,
sync_donuts = false,
}
```
</details>

## ✅☑️ TODO
- [ ] add colors to donuts
- [ ] center donut horizontally inside of the window
\
If you want to change the default configuration, you can call the `setup` function.

```lua
require("donut").setup({
timeout = 60,
sync_donuts = true,
}
```
or you can just set `vim.g.donut_config` to a table with the configuration you want.

```lua
vim.g.donut_config = { timeout = 30, sync_donuts = false }
```


## 🎭 Inspiration
- [donut.c](https://www.a1k0n.net/2011/07/20/donut-math.html)

- [donut.c](https://www.a1k0n.net/2011/07/20/donut-math.html)

## Other Neovim screensavers
- [zone](https://github.com/tamton-aquib/zone.nvim)
- [cellular-automaton](https://github.com/Eandrju/cellular-automaton.nvim)
- [drop](https://github.com/folke/drop.nvim)
- [I'm waiting for this one](https://www.reddit.com/r/neovim/comments/1bsebep/raining_inside_neovim/)

- [zone](https://github.com/tamton-aquib/zone.nvim)
- [cellular-automaton](https://github.com/Eandrju/cellular-automaton.nvim)
- [drop](https://github.com/folke/drop.nvim)
- [I'm waiting for this one](https://www.reddit.com/r/neovim/comments/1bsebep/raining_inside_neovim/)

0 comments on commit 9e0b902

Please sign in to comment.