Skip to content

Commit 44e1237

Browse files
committed
chore: update readme [ci skip]
1 parent a8d27cc commit 44e1237

File tree

1 file changed

+46
-38
lines changed

1 file changed

+46
-38
lines changed

README.md

Lines changed: 46 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,96 @@
11
# vue-next [![beta](https://img.shields.io/npm/v/vue/next.svg)](https://www.npmjs.com/package/vue/v/next) [![CircleCI](https://circleci.com/gh/vuejs/vue-next.svg?style=svg&circle-token=fb883a2d0a73df46e80b2e79fd430959d8f2b488)](https://circleci.com/gh/vuejs/vue-next)
22

3-
## Status: Release Candidate
3+
This is the repository for Vue 3.0.
44

5-
- All planned RFCs have been merged.
5+
## Quickstart
66

7-
- All [merged RFCs](https://github.com/vuejs/rfcs/pulls?q=is%3Apr+is%3Amerged+label%3A3.x) have been implemented.
7+
- Via CDN: `<script src="https://unpkg.com/vue@next"></script>`
8+
- In-browser playground on [Codepen](https://codepen.io/yyx990803/pen/OJNoaZL)
9+
- Scaffold via [Vite](https://github.com/vitejs/vite):
810

9-
- Vue CLI now has experimental support via [vue-cli-plugin-vue-next](https://github.com/vuejs/vue-cli-plugin-vue-next).
11+
```bash
12+
npm init vite-app hello-vue3 # OR yarn create vite-app hello-vue3
13+
```
1014

11-
- There is also a simple plain webpack-based setup with Single-File Component support available [here](https://github.com/vuejs/vue-next-webpack-preview).
15+
- Scaffold via [vue-cli](https://cli.vuejs.org/):
1216

13-
Please note that there could still be undocumented behavior inconsistencies with 2.x. When you run into such a case, please make sure to first check if the behavior difference has already been proposed in an existing RFC. If the inconsistency is not part of an RFC, then it's likely unintended, and an issue should be opened (please make sure to use the [issue helper](https://new-issue.vuejs.org/?repo=vuejs/vue-next) when opening new issues).
17+
```bash
18+
npm install -g @vue/cli # OR yarn global add @vue/cli
19+
vue create hello-vue3
20+
# select vue 3 preset
21+
```
1422

15-
In addition, the current implementation requires native ES2015+ in the runtime environment and does not support IE11 (yet). The IE11 compatible build will be worked on after we have reached RC stage.
23+
## Changes from Vue 2
1624

17-
The documentation of Vue 3 can be found at https://v3.vuejs.org/
25+
Please consult the [Migration Guide](https://v3.vuejs.org/guide/migration/introduction.html).
1826

19-
## Status of the rest of the framework
27+
- Note: IE11 support is still pending.
28+
29+
## Supporting Libraries
30+
31+
All of our official libraries and tools now support Vue 3, but most of them are still in beta status and distributed under the `next` dist tag on NPM. **We are planning to stabilize and switch all projects to use the `latest` dist tag by end of 2020.**
32+
33+
### Vue CLI
34+
35+
As of v4.5.0, `vue-cli` now provides built-in option to choose Vue 3 preset when creating a new project. You can upgrade `vue-cli` and run `vue create` to create a Vue 3 project today.
2036

2137
### Vue Router
2238

39+
Vue Router 4.0 provides Vue 3 support and has a number of breaking changes of its own. Check out its [Migration Guide](https://next.router.vuejs.org/guide/migration/) for full details.
40+
2341
- [![beta](https://img.shields.io/npm/v/vue-router/next.svg)](https://www.npmjs.com/package/vue-router/v/next)
2442
- [Github](https://github.com/vuejs/vue-router-next)
2543
- [RFCs](https://github.com/vuejs/rfcs/pulls?q=is%3Apr+is%3Amerged+label%3Arouter)
2644

2745
### Vuex
2846

47+
Vuex 4.0 provides Vue 3 support with largely the same API as 3.x. The only breaking change is [how the plugin is installed](https://github.com/vuejs/vuex/tree/4.0#breaking-changes).
48+
2949
- [![beta](https://img.shields.io/npm/v/vuex/next.svg)](https://www.npmjs.com/package/vuex/v/next)
3050
- [Github](https://github.com/vuejs/vuex/tree/4.0)
3151

32-
The only difference between Vuex 4.0 and 3.x is that it's Vue 3 compatible! It is ready to enter RC together with Vue 3 core.
33-
34-
### Vue CLI
35-
36-
As of v4.5.0, `vue-cli` now provides built-in option to choose Vue 3 preset when creating a new project.
52+
### Devtools Extension
3753

38-
### JSX Support
54+
We are working on a new version of the Devtools with a new UI and refactored internals to support multiple Vue versions. The new version is currently in beta and only supports Vue 3 (for now). Vuex and Router integration is also work in progress.
3955

40-
There are currently two JSX transform implementations for Vue 3 with slightly differing syntax (for Vue specific features):
56+
- For Chrome: [Install from Chrome web store](https://chrome.google.com/webstore/detail/vuejs-devtools/ljjemllljcmogpfapbkkighbhhppjdbg?hl=en)
4157

42-
- [vuejs/jsx-next](https://github.com/vuejs/jsx-next)
43-
- [HcySunYang/vue-next-jsx](https://github.com/HcySunYang/vue-next-jsx)
58+
- Note: the beta channel may conflict with the stable version of devtools so you may need to temporarily disable the stable version for the beta channel to work properly.
4459

45-
We are using [this thread](https://github.com/vuejs/jsx/issues/141) to unify the design and land on an official specification of how Vue features should be handled in JSX. If you use Vue with JSX, please provide your feedback in that thread.
60+
- For Firefox: [Download the signed extension](https://github.com/vuejs/vue-devtools/releases/tag/v6.0.0-beta.2) (`.xpi` file under Assets)
4661

4762
### Other Projects
4863

49-
| Project | Status |
50-
| ------------------- | ------ |
51-
| vue-devtools | [![alpha][vd-badge]][vd-npm] [[Github][vd-code]] |
52-
| eslint-plugin-vue | [![alpha][epv-badge]][epv-npm] [[Github][epv-code]] |
53-
| @vue/test-utils | [![alpha][vtu-badge]][vtu-npm] [[Github][vtu-code]] |
54-
| vue-class-component | [![alpha][vcc-badge]][vcc-npm] [[Github][vcc-code]] |
55-
| vue-loader | [![alpha][vl-badge]][vl-npm] [[Github][vl-code]] |
56-
| rollup-plugin-vue | [![alpha][rpv-badge]][rpv-npm] [[Github][rpv-code]] |
57-
64+
| Project | NPM | Repo |
65+
| --------------------- | ----------------------------- | -------------------- |
66+
| @vue/babel-plugin-jsx | [![rc][jsx-badge]][jsx-npm] | [[Github][jsx-code]] |
67+
| eslint-plugin-vue | [![beta][epv-badge]][epv-npm] | [[Github][epv-code]] |
68+
| @vue/test-utils | [![beta][vtu-badge]][vtu-npm] | [[Github][vtu-code]] |
69+
| vue-class-component | [![beta][vcc-badge]][vcc-npm] | [[Github][vcc-code]] |
70+
| vue-loader | [![beta][vl-badge]][vl-npm] | [[Github][vl-code]] |
71+
| rollup-plugin-vue | [![beta][rpv-badge]][rpv-npm] | [[Github][rpv-code]] |
72+
73+
[jsx-badge]: https://img.shields.io/npm/v/@vue/babel-plugin-jsx.svg
74+
[jsx-npm]: https://www.npmjs.com/package/@vue/babel-plugin-jsx
75+
[jsx-code]: https://github.com/vuejs/jsx-next
5876
[vd-badge]: https://img.shields.io/npm/v/@vue/devtools/beta.svg
5977
[vd-npm]: https://www.npmjs.com/package/@vue/devtools/v/beta
6078
[vd-code]: https://github.com/vuejs/vue-devtools/tree/next
61-
6279
[epv-badge]: https://img.shields.io/npm/v/eslint-plugin-vue/next.svg
6380
[epv-npm]: https://www.npmjs.com/package/eslint-plugin-vue/v/next
6481
[epv-code]: https://github.com/vuejs/eslint-plugin-vue
65-
6682
[vtu-badge]: https://img.shields.io/npm/v/@vue/test-utils/next.svg
6783
[vtu-npm]: https://www.npmjs.com/package/@vue/test-utils/v/next
6884
[vtu-code]: https://github.com/vuejs/vue-test-utils-next
69-
7085
[jsx-badge]: https://img.shields.io/npm/v/@ant-design-vue/babel-plugin-jsx.svg
7186
[jsx-npm]: https://www.npmjs.com/package/@ant-design-vue/babel-plugin-jsx
7287
[jsx-code]: https://github.com/vueComponent/jsx
73-
7488
[vcc-badge]: https://img.shields.io/npm/v/vue-class-component/next.svg
7589
[vcc-npm]: https://www.npmjs.com/package/vue-class-component/v/next
7690
[vcc-code]: https://github.com/vuejs/vue-class-component/tree/next
77-
7891
[vl-badge]: https://img.shields.io/npm/v/vue-loader/next.svg
7992
[vl-npm]: https://www.npmjs.com/package/vue-loader/v/next
8093
[vl-code]: https://github.com/vuejs/vue-loader/tree/next
81-
8294
[rpv-badge]: https://img.shields.io/npm/v/rollup-plugin-vue/next.svg
8395
[rpv-npm]: https://www.npmjs.com/package/rollup-plugin-vue/v/next
8496
[rpv-code]: https://github.com/vuejs/rollup-plugin-vue/tree/next
85-
86-
## Contribution
87-
88-
See [Contributing Guide](https://github.com/vuejs/vue-next/blob/master/.github/contributing.md).

0 commit comments

Comments
 (0)