Skip to content

Commit aba502f

Browse files
authored
docs: update readme
1 parent 595ebb8 commit aba502f

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,18 @@ A Neovim plugin that display prettier diagnostic messages. Display one line diag
66

77
![tinyinlinediagnostic](https://github.com/rachartier/tiny-inline-diagnostic.nvim/assets/2057541/6a6eb093-f473-4e61-b344-08317c6b78e9)
88

9+
10+
### Overflow handling enabled
11+
12+
13+
![tinyinlinediagnostic_wrap](https://github.com/rachartier/tiny-inline-diagnostic.nvim/assets/2057541/6cc4e622-a4a0-4894-b5c8-76141d4ecd52)
14+
15+
16+
### Break line enabled
17+
18+
![image](https://github.com/rachartier/tiny-inline-diagnostic.nvim/assets/2057541/b91625be-ddce-4bb9-979b-f640417a8ed9)
19+
20+
921
## 🛠️ Setup
1022

1123
- You need to set `vim.opt.updatetime` to trigger `CursorEvent` faster (ex: `vim.opt.updatetime = 100`)
@@ -50,6 +62,14 @@ require('tiny-inline-diagnostic').setup({
5062
},
5163
options = {
5264
clear_on_insert = false,
65+
--- When overflow="wrap", when the message is too long, it is then displayed on multiple lines.
66+
overflow = "wrap",
67+
68+
--- Enable it if you want to always have message with `after` characters length.
69+
break_line = {
70+
enabled = false,
71+
after = 30,
72+
}
5373
}
5474
})
5575
```

0 commit comments

Comments
 (0)