Skip to content

Commit c3fb724

Browse files
authored
Update README (#7)
1 parent 86ae9aa commit c3fb724

File tree

1 file changed

+8
-19
lines changed

1 file changed

+8
-19
lines changed

README.md

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,11 @@
11
# tree-sitter-taskr
2-
This is the tree-sitter parser for [taskr](https://github.com/arne-vl/taskr). Currently only provides highlighting.
32

4-
## Manual configuration
5-
1. Put this snippet in your nvim-treesiter configuration.
6-
```lua
7-
local parser_config = require("nvim-treesitter.parsers").get_parser_configs()
8-
parser_config.taskr = {
9-
install_info = {
10-
url = "https://github.com/arne-vl/tree-sitter-taskr",
11-
files = { "src/parser.c" },
12-
branch = "main",
13-
generate_requires_npm = true,
14-
requires_generate_from_grammar = true,
15-
},
16-
filetype = "taskrfile",
17-
}
18-
```
3+
A [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) grammar for the [taskr](https://github.com/arne-vl/taskr) configuration language.
4+
5+
This parser enables syntax highlighting for the `taskrfile` filetype in editors and tools that support Tree-sitter.
6+
7+
## ✨ Features
8+
- Full grammar for Taskr syntax
9+
- Incremental parsing for fast editor feedback
10+
- Can be integrated with editors, syntax highlighters, and static analysis tools
1911

20-
2. Restart `nvim` and install the parser using `:TSInstall taskr`
21-
3. Copy the contents of `queries/taskr/highlights.scm` into `~/.config/nvim/queries/taskr/highlights.scm`
22-
4. Restart `nvim`.

0 commit comments

Comments
 (0)