Skip to content

Commit bdf1bc6

Browse files
committed
docs: add badges, rename demo gif, add updatetime tip
1 parent 081646f commit bdf1bc6

2 files changed

Lines changed: 10 additions & 1 deletion

File tree

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# focal.nvim
22

3+
[![CI](https://github.com/hmdfrds/focal.nvim/actions/workflows/ci.yml/badge.svg)](https://github.com/hmdfrds/focal.nvim/actions/workflows/ci.yml)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
5+
[![Neovim](https://img.shields.io/badge/Neovim-0.10%2B-green.svg)](https://neovim.io)
6+
37
> Universal file preview for Neovim. Hover over a file in any explorer, see a preview.
48
5-
![focal.nvim demo](assets/bruh.gif)
9+
![focal.nvim demo](assets/demo.gif)
610

711
focal.nvim is an extensible preview framework with dual backends (pixel-perfect via image.nvim, Unicode fallback via chafa) and a plugin adapter system that works with any file explorer.
812

@@ -54,6 +58,11 @@ Generic:
5458
require("focal").setup({})
5559
```
5660

61+
> **Tip:** Neovim's default `updatetime` is 4000ms, which means previews take 4 seconds to appear. Most users set it lower for responsive LSP diagnostics, which also makes focal snappier:
62+
> ```lua
63+
> vim.o.updatetime = 300
64+
> ```
65+
5766
## Configuration
5867
5968
All options with their defaults:
File renamed without changes.

0 commit comments

Comments
 (0)