Skip to content

Commit 90aceab

Browse files
doc: update README
1 parent b40fdce commit 90aceab

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,9 @@ Async formatting and linting utility for neovim `0.10+`.
88

99
## Features
1010

11-
- Blazingly fast
12-
- Async using coroutine and luv spawn
11+
- Async and blazingly fast
1312
- Builtin support for popular formatters and linters
14-
- Easy configuration for custom tools
13+
- Minimal API allowing for full customization
1514
- Light-weight
1615

1716
## Usage
@@ -64,8 +63,12 @@ vim.g.guard_config = {
6463
}
6564
```
6665

67-
- Use `Guard fmt` to manually call format, when there is a visual selection only the selection is formatted. **NOTE**: Regional formatting just sends your selection to the formatter, if there's not enough context incoherent formatting might occur (e.g. indent being erased)
66+
- Use `Guard fmt` to manually call format, when there is a visual selection only the selection is formatted. **NOTE**: Regional formatting is best-effort, expect inconsistencies.
6867
- `enable-fmt`, `disable-fmt` turns auto formatting on and off for the current buffer.
68+
- Use `Guard Lint` to lint manually.
69+
- `enable-lint` and `disable-lint` controls auto linting for the current buffer.
70+
71+
## Examples
6972

7073
Format c files with clang-format and lint with clang-tidy:
7174

@@ -95,9 +98,6 @@ Lint all your files with `codespell`
9598
ft('*'):lint('codespell')
9699
```
97100

98-
- Use `Guard Lint` to lint manually.
99-
- `enable-lint` and `disable-lint` controls auto linting for the current buffer.
100-
101101
You can also easily create your own configuration that's not in `guard-collection`, see [CUSTOMIZE.md](./CUSTOMIZE.md).
102102

103103
For more niche use cases, [ADVANCED.md](./ADVANCED.md) demonstrates how to:

0 commit comments

Comments
 (0)