Skip to content

Commit 8ff6337

Browse files
committed
Update README
1 parent ed3883c commit 8ff6337

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

server/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
## Vue Language Server
22

3-
`vue-language-server` is a language server implementation compatible with [`language-server-protocol`](https://github.com/Microsoft/language-server-protocol).
3+
Vue Language Server (`vls`) is a language server implementation compatible with [`language-server-protocol`](https://github.com/Microsoft/language-server-protocol).
44

5-
Vetur is the VS Code client consuming `vue-language-server`.
5+
Vetur is the VS Code client consuming `vls`.
66

7-
It's possible for other `language-server-protocol` compatible editors to build language server clients that consume VLS.
7+
It's possible for other LSP compatible editors to build language server clients that consume `vls`.
88

99
## Usage
1010

11-
There are two ways to integrate `vue-language-server` into editors:
11+
There are two ways to integrate `vls` into editors:
1212

1313
1. As a global executable.
1414

@@ -17,7 +17,7 @@ There are two ways to integrate `vue-language-server` into editors:
1717
First, install VLS globally.
1818

1919
```bash
20-
npm install vue-language-server -g
20+
npm install vls -g
2121
```
2222

2323
This will provide you the global `vls` command.
@@ -35,18 +35,18 @@ There are two ways to integrate `vue-language-server` into editors:
3535

3636
Example: https://github.com/HerringtonDarkholme/atom-vue
3737

38-
First, install vue-language-server as a local dependency.
38+
First, install vls as a local dependency.
3939

4040
```bash
41-
npm install vue-language-server --save
41+
npm install vls --save
4242
```
4343

44-
Then, require the vue-language-server, this would typically look like:
44+
Then, require the vls, this would typically look like:
4545

4646
```ts
4747
class VueLanguageClient extends AutoLanguageClient {
4848
startServerProcess () {
49-
return cp.spawn('node', [require.resolve('vue-language-server/dist/htmlServerMain')])
49+
return cp.spawn('node', [require.resolve('vls/dist/htmlServerMain')])
5050
}
5151
}
5252
```

0 commit comments

Comments
 (0)