]> git.ipfire.org Git - thirdparty/vuejs/create-vue.git/commitdiff
chore: add information for Vue CLI users [ci skip]
authorEvan You <yyx990803@gmail.com>
Wed, 17 Aug 2022 08:00:04 +0000 (16:00 +0800)
committerEvan You <yyx990803@gmail.com>
Wed, 17 Aug 2022 08:00:04 +0000 (16:00 +0800)
README.md
media/screenshot-browser.png [new file with mode: 0644]
media/screenshot-cli.png [new file with mode: 0644]

index 0978d793bff374e2ba0aa60aa2c56a7084e36f14..fbc856c53885470d641ee0baa91b98d4d198974a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # create-vue
 
-An easy way to start a Vue project
+The recommended way to start a Vite-powered Vue project
 
 ## Usage
 
@@ -15,3 +15,15 @@ npm init vue@2
 ```
 
 Note that the version number (`@3` or `@2`) MUST NOT be omitted, otherwise `npm` may resolve to a cached and outdated version of the package.
+
+## Difference from Vue CLI
+
+- Vue CLI is based on webpack, while `create-vue` is based on [Vite](https://vitejs.dev/). Vite supports most of the configured conventions found in Vue CLI projects out of the box, and provides a significantly better development experience due to its extremely fast startup and hot-module replacement speed. Learn more about why we recommend Vite over webpack [here](https://vitejs.dev/guide/why.html).
+
+- Unlike Vue CLI, `create-vue` itself is just a scaffolding tool: it creates a pre-configured project base on the features you choose, and delegates the rest to Vite. Projects scaffolded this way can directly leverage the [Vite plugin ecosystem](https://vitejs.dev/plugins/) which is Rollup-compatible.
+
+## Migrating from Vue CLI
+
+- [Vue CLI -> Vite Migration Guide from VueSchool.io](https://vueschool.io/articles/vuejs-tutorials/how-to-migrate-from-vue-cli-to-vite/)
+
+- [Tools / Plugins that help with auto migration](https://github.com/vitejs/awesome-vite#vue-cli)
diff --git a/media/screenshot-browser.png b/media/screenshot-browser.png
new file mode 100644 (file)
index 0000000..132dd9f
Binary files /dev/null and b/media/screenshot-browser.png differ
diff --git a/media/screenshot-cli.png b/media/screenshot-cli.png
new file mode 100644 (file)
index 0000000..d57010e
Binary files /dev/null and b/media/screenshot-cli.png differ