Skip to content

Commit 03762c4

Browse files
committed
docs: update README
1 parent b349ea8 commit 03762c4

File tree

1 file changed

+4
-26
lines changed

1 file changed

+4
-26
lines changed

Diff for: README.md

+4-26
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,13 @@
11
# tree-sitter-rbs
22

3+
[![Build/test](https://github.com/joker1007/tree-sitter-rbs/actions/workflows/ci.yml/badge.svg)](https://github.com/joker1007/tree-sitter-rbs/actions/workflows/ci.yml)
4+
35
[rbs](https://github.com/ruby/rbs) grammar for [tree-sitter](https://github.com/tree-sitter/tree-sitter).
46

57
syntax reference is https://github.com/ruby/rbs/blob/master/docs/syntax.md
68

79
## Use this in Neovim
810

9-
1. add following code to install parser manually.
10-
11-
```lua
12-
local parser_config = require("nvim-treesitter.parsers").get_parser_configs()
13-
parser_config.rbs = {
14-
install_info = {
15-
url = "https://github.com/joker1007/tree-sitter-rbs",
16-
files = { "src/parser.c" },
17-
branch = "main",
18-
},
19-
filetype = "rbs",
20-
}
21-
```
22-
23-
2. run `:TSInstall rbs`
24-
25-
3. install this repository as a neovim plugin
26-
27-
```lua
28-
-- lazy.nvim
29-
require("lazy").setup({
30-
"joker1007/tree-sitter-rbs"
31-
})
11+
this parser is supported in nvim-treesitter. (https://github.com/nvim-treesitter/nvim-treesitter/pull/5745)
3212

33-
-- packer.nvim
34-
use { "joker1007/tree-sitter-rbs" }
35-
```
13+
Please run `:TSInstall rbs`

0 commit comments

Comments
 (0)