Skip to content

Commit 955a89a

Browse files
committed
Add Setup section to README
1 parent 0282d3e commit 955a89a

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
22

33
VSCode support for the [syntax_tree](https://github.com/ruby-syntax-tree/syntax_tree) gem. Available for download in the [VSCode marketplace](https://marketplace.visualstudio.com/items?itemName=ruby-syntax-tree.vscode-syntax-tree).
44

5+
## Setup
6+
7+
After installing the [syntax_tree](https://github.com/ruby-syntax-tree/syntax_tree) gem and the [VSCode extension](https://marketplace.visualstudio.com/items?itemName=ruby-syntax-tree.vscode-syntax-tree), add the following to your VSCode `settings.json` to format Ruby on save.
8+
9+
```json
10+
"[ruby]": {
11+
"editor.formatOnSave": true,
12+
"editor.defaultFormatter": "ruby-syntax-tree.vscode-syntax-tree"
13+
},
14+
```
15+
16+
You can find additional config options by searching for "syntax tree" in your VSCode settings.
17+
18+
519
## Contributing
620

721
Bug reports and pull requests are welcome on GitHub at https://github.com/ruby-syntax-tree/vscode-syntax-tree.

0 commit comments

Comments
 (0)