From c26980063166b6129184ed7653df25289b19895a Mon Sep 17 00:00:00 2001 From: Evan You Date: Mon, 29 Jun 2020 18:50:00 -0400 Subject: [PATCH] chore: readme update status [ci skip] --- README.md | 84 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 57 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 3ec8488d..cfe090bf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# vue-next [![CircleCI](https://circleci.com/gh/vuejs/vue-next.svg?style=svg&circle-token=fb883a2d0a73df46e80b2e79fd430959d8f2b488)](https://circleci.com/gh/vuejs/vue-next) +# 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) -## Status: Beta. +## Status: Beta - All planned RFCs have been merged. @@ -14,34 +14,64 @@ Please note that there could still be undocumented behavior inconsistencies with 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. -## Official Libraries Vue 3 Support Status +## Status of the rest of the framework -| Project | Status | -|---------|--------| -| vue-router | Alpha [[Proposed RFCs][router-rfcs]] [[GitHub][router-code]] [[npm][router-npm]] | -| vuex | Beta, with same API [[GitHub][vuex-code]] [[npm][vuex-npm]] | -| vue-class-component | Alpha [[Github][vcc-code]] [[npm][vcc-npm]] | -| vue-cli | Experimental support via [vue-cli-plugin-vue-next][cli] | -| eslint-plugin-vue | Alpha [[Github][epv-code]] [[npm][epv-npm]] | -| vue-test-utils | Alpha [[Github][vtu-code]] [[npm][vtu-npm]] | -| vue-devtools | WIP | -| jsx | WIP | +### Vue Router -[router-code]: https://github.com/vuejs/vue-router-next -[router-rfcs]: https://github.com/vuejs/rfcs/pulls?q=is%3Apr+is%3Aopen+label%3Arouter -[router-npm]: https://unpkg.com/vue-router@next/ -[vuex-code]: https://github.com/vuejs/vuex/tree/4.0 -[vuex-npm]: https://unpkg.com/vuex@next/ -[cli]: https://github.com/vuejs/vue-cli-plugin-vue-next -[vue-loader-code]: https://github.com/vuejs/vue-loader/tree/next -[vue-loader-npm]: https://unpkg.com/vue-loader@next/ -[vcc-code]: https://github.com/vuejs/vue-class-component/tree/next -[vcc-npm]: https://unpkg.com/vue-class-component@next/ -[vtu-code]: https://github.com/vuejs/vue-test-utils-next -[vtu-npm]: https://www.npmjs.com/package/@vue/test-utils +- [![alpha](https://img.shields.io/npm/v/vue-router/next.svg)](https://www.npmjs.com/package/vue-router/v/next) +- [Github](https://github.com/vuejs/vue-router-next) +- [RFCs](https://github.com/vuejs/rfcs/pulls?q=is%3Apr+is%3Amerged+label%3Arouter) + +We still have a few minor router hook behavior consistency issues with `vue-router@3.x`, but these are the only things that is blocking the router from being marked as Beta. The router is usable for new, non-critical projects. + +### Vuex + +- [![beta](https://img.shields.io/npm/v/vuex/next.svg)](https://www.npmjs.com/package/vuex/v/next) +- [Github](https://github.com/vuejs/vuex/tree/4.0) + +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. + +### Vue CLI + +Vue 3 support in Vue CLI is currently provided via the [vue-cli-plugin-vue-next](https://github.com/vuejs/vue-cli-plugin-vue-next) plugin. You can scaffold a new project and then run `vue add vue-next` to switch to Vue 3. Vue 3 will become a option in the project creation process when it reaches RC. + +Note if you are not particularly attached to webpack and IE11 support, you can also start a Vue 3 project with [Vite](https://github.com/vitejs/vite). + +### Other Projects + +| Project | Status | +| ------------------- | ------ | +| vue-devtools | WIP (beta channel with Vue 3 support in early July) | +| eslint-plugin-vue | [![alpha][epv-badge]][epv-npm] [[Github][epv-code]] | +| @vue/test-utils | [![alpha][vtu-badge]][vtu-npm] [[Github][vtu-code]] | +| Babel jsx transform | [![alpha][jsx-badge]][jsx-npm] [[Github][jsx-code]] | +| vue-class-component | [![alpha][vcc-badge]][vcc-npm] [[Github][vcc-code]] | +| vue-loader | [![alpha][vl-badge]][vl-npm] [[Github][vl-code]] | +| rollup-plugin-vue | [![alpha][rpv-badge]][rpv-npm] [[Github][jsx-code]] | + +[epv-badge]: https://img.shields.io/npm/v/eslint-plugin-vue/next.svg +[epv-npm]: https://www.npmjs.com/package/eslint-plugin-vue/v/next [epv-code]: https://github.com/vuejs/eslint-plugin-vue -[epv-npm]: https://unpkg.com/browse/eslint-plugin-vue@7.0.0-alpha.0/ -[vue-devtools]: https://github.com/vuejs/vue-devtools + +[vtu-badge]: https://img.shields.io/npm/v/@vue/test-utils/next.svg +[vtu-npm]: https://www.npmjs.com/package/@vue/test-utils/v/next +[vtu-code]: https://github.com/vuejs/vue-test-utils-next + +[jsx-badge]: https://img.shields.io/npm/v/@ant-design-vue/babel-plugin-jsx.svg +[jsx-npm]: https://www.npmjs.com/package/@ant-design-vue/babel-plugin-jsx +[jsx-code]: https://github.com/vueComponent/jsx + +[vcc-badge]: https://img.shields.io/npm/v/vue-class-component/next.svg +[vcc-npm]: https://www.npmjs.com/package/vue-class-component/v/next +[vcc-code]: https://github.com/vuejs/vue-class-component/tree/next + +[vl-badge]: https://img.shields.io/npm/v/vue-loader/next.svg +[vl-npm]: https://www.npmjs.com/package/vue-loader/v/next +[vl-code]: https://github.com/vuejs/vue-loader/tree/next + +[rpv-badge]: https://img.shields.io/npm/v/rollup-plugin-vue/next.svg +[rpv-npm]: https://www.npmjs.com/package/rollup-plugin-vue/v/next +[rpv-code]: https://github.com/vuejs/rollup-plugin-vue/tree/next ## Contribution