Skip to content

Commit 9b640ac

Browse files
committed
docs: update readme
1 parent fe42ac1 commit 9b640ac

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ A Neovim plugin that display prettier diagnostic messages. Display one line diag
1818

1919
## 🛠️ Setup
2020

21-
- You need to set `vim.opt.updatetime` to trigger `CursorEvent` faster (ex: `vim.opt.updatetime = 100`)
22-
- You also need to set `vim.diagnostic.config({ virtual_text = false })`, to not have all diagnostics in the buffer displayed.
21+
- You need to set `vim.diagnostic.config({ virtual_text = false })`, to not have all diagnostics in the buffer displayed.
2322

2423
## 📥 Installation
2524

@@ -55,7 +54,7 @@ require('tiny-inline-diagnostic').setup({
5554
info = "DiagnosticInfo",
5655
hint = "DiagnosticHint",
5756
arrow = "NonText",
58-
background = "None", -- Should be "None" or a hexadecimal color (#RRGGBB)
57+
background = "CursorLine", -- Can be a highlight or a hexadecimal color (#RRGGBB)
5958
},
6059
blend = {
6160
factor = 0.27,
@@ -94,7 +93,5 @@ require('tiny-inline-diagnostic').setup({
9493

9594
## ❓ FAQ:
9695

97-
- **Q**: It takes a long time for the diagnostic to appear:
98-
- You need to set `vim.opt.updatetime = 100` (or any number in ms). It will trigger the `CursorHold` event faster.
9996
- **Q**: All diagnostics are still displayed
10097
- You need to set `vim.diagnostic.config({ virtual_text = false })` to remove all the others diagnostics.

0 commit comments

Comments
 (0)