Skip to content

Commit 47d87ca

Browse files
committed
chore: update readme [ci skip]
1 parent 2e71f07 commit 47d87ca

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

README.md

+22-9
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@ This is the repository for Vue 3.0.
99
- Scaffold via [Vite](https://github.com/vitejs/vite):
1010

1111
```bash
12-
npm init vite-app hello-vue3 # OR yarn create vite-app hello-vue3
12+
# npm
13+
npm init @vitejs/app
14+
# yarn
15+
yarn create @vitejs/app
16+
# select vue template
1317
```
1418

1519
- Scaffold via [vue-cli](https://cli.vuejs.org/):
@@ -61,18 +65,27 @@ We are working on a new version of the Devtools with a new UI and refactored int
6165

6266
### IDE Support
6367

64-
It is recommended to use [VSCode](https://code.visualstudio.com/) with our official extension [Vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur), which provides comprehensive IDE support for Vue 3.
68+
It is recommended to use [VSCode](https://code.visualstudio.com/). There are currently two viable extensions for Single-File Components (SFCs) support:
69+
70+
- [Vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur) (recommended if you are used to Vetur features)
71+
- [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (recommended if using TypeScript with SFCs, or `<script setup>` syntax)
72+
73+
### TypeScript Support
74+
75+
- All Vue 3 packages ship with types.
76+
- [vue-tsc](https://github.com/johnsoncodehk/vue-tsc) perform TypeScript type checks / diagnostics on Vue SFCs via the command line.
77+
- [vue-dts-gen](https://github.com/egoist/vue-dts-gen): generate TypeScript definitions from Vue SFCs.
6578

6679
### Other Projects
6780

68-
| Project | NPM | Repo |
69-
| --------------------- | ----------------------------- | -------------------- |
70-
| @vue/babel-plugin-jsx | [![rc][jsx-badge]][jsx-npm] | [[GitHub][jsx-code]] |
81+
| Project | NPM | Repo |
82+
| --------------------- | ------------------------------- | -------------------- |
83+
| @vue/babel-plugin-jsx | [![rc][jsx-badge]][jsx-npm] | [[GitHub][jsx-code]] |
7184
| eslint-plugin-vue | [![stable][epv-badge]][epv-npm] | [[GitHub][epv-code]] |
72-
| @vue/test-utils | [![beta][vtu-badge]][vtu-npm] | [[GitHub][vtu-code]] |
73-
| vue-class-component | [![beta][vcc-badge]][vcc-npm] | [[GitHub][vcc-code]] |
74-
| vue-loader | [![beta][vl-badge]][vl-npm] | [[GitHub][vl-code]] |
75-
| rollup-plugin-vue | [![beta][rpv-badge]][rpv-npm] | [[GitHub][rpv-code]] |
85+
| @vue/test-utils | [![beta][vtu-badge]][vtu-npm] | [[GitHub][vtu-code]] |
86+
| vue-class-component | [![beta][vcc-badge]][vcc-npm] | [[GitHub][vcc-code]] |
87+
| vue-loader | [![beta][vl-badge]][vl-npm] | [[GitHub][vl-code]] |
88+
| rollup-plugin-vue | [![beta][rpv-badge]][rpv-npm] | [[GitHub][rpv-code]] |
7689

7790
[jsx-badge]: https://img.shields.io/npm/v/@vue/babel-plugin-jsx.svg
7891
[jsx-npm]: https://www.npmjs.com/package/@vue/babel-plugin-jsx

0 commit comments

Comments
 (0)