Skip to content

Commit

Permalink
doc: add LSP package name to the readme (vuejs#3950)
Browse files Browse the repository at this point in the history
The README contains no direct reference to the language server itself.
Given past  renames and the legacy Vetur, it's not straightforward to
fine the correct package online.

Include the LSP and its package name in the README. This will assist
people trying to install the language server.

Additionally, as of 2.0.0, a plug-in is required for TypeScript support.
This is mentioned in the changelog, but the name of the plug-in itself
is not made evident anywhere. Also add this to the README.
  • Loading branch information
WhyNotHugo authored and so1ve committed Mar 4, 2024
1 parent 7264faf commit 0f958db
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@
*Component props, events, slots types information extract tool*
- [vite-plugin-vue-component-preview](https://github.com/johnsoncodehk/vite-plugin-vue-component-preview) \
*Vite plugin for support Vue component preview view with `Vue Language Features`*
- [`@vue/language-server`](/packages/language-server/) \
*The language server itself*.
- [`@vue/typescript-plugin`](/packages/typescript-plugin/) \
*Typescript plugin for the language server*.

## Community Integration

Expand Down

0 comments on commit 0f958db

Please sign in to comment.