Skip to content

Commit 624121a

Browse files
committed
Update README
1 parent 0961095 commit 624121a

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,34 @@
11
# vim-rescript
22

3-
**This is the official vim plugin for ReScript for vanilla VIM and vim-coc.**
3+
**This is the official vim plugin for ReScript.**
44

55
> If you are experiencing any troubles, open an issue or visit our [Forum](https://forum.rescript-lang.org) and ask for guidance.
66
7-
See `:h rescript` for the detailed [helpfile](./doc/rescript.txt).
8-
9-
## Requirements
10-
11-
The plugin works with projects based on `bs-platform@8.3` or later
12-
137
## Features
148

9+
**Supported Workflows:**
10+
- Plain VIM (without any third party plugins)
11+
- LSP + [coc-vim](https://github.com/neoclide/coc.nvim)
12+
1513
**Basics:**
1614
- Syntax highlighting for ReSript files
1715
- Filetype detection for `.res`, `.resi`
1816
- Basic automatic indentation
1917
- Includes LSP for coc-vim usage
2018

2119
**Provided by vim-rescript commands:**
22-
- Formatting `.res` files
23-
- Type Hinting for current cursor position
24-
- Build command
25-
- Display syntax error / build error diagnostics in VIM quickfix
26-
- Autocompletion w/ Vim's omnicomplete
20+
- Formatting `.res` files w/ syntax error diagnostics in VIM quickfix
2721
- Convert existing `.re` /`.rei` files to `.res` /`.resi`
22+
- Type hint for current cursor position
23+
- Jump to definition for current cursor position
24+
- Building the current projec w/ build diagnostics in VIM quickfix
25+
- Autocompletion w/ Vim's omnicomplete
26+
27+
See `:h rescript` for the detailed [helpfile](./doc/rescript.txt).
28+
29+
## Requirements
30+
31+
The plugin works with projects based on `bs-platform@8.3` or later
2832

2933
## Installation
3034

@@ -115,7 +119,6 @@ set omnifunc=rescript#Complete
115119
set completeopt+=preview
116120
```
117121

118-
119122
## Credits
120123

121124
- [amirales](https://github.com/amiralies): Started the plugin w/ syntax & indent functionality

0 commit comments

Comments
 (0)