Skip to content

Commit a40d5a7

Browse files
doc: update image, add warning message for vue 2 EOL
1 parent f2e555d commit a40d5a7

File tree

2 files changed

+15
-8
lines changed

2 files changed

+15
-8
lines changed

README.md

+15-8
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,38 @@
33
The recommended way to start a Vite-powered Vue project
44

55
<p align="center">
6-
<img src="https://github.com/vuejs/create-vue/blob/main/media/screenshot-cli.png?raw=true" width="800">
6+
<img src="https://github.com/vuejs/create-vue/blob/main/media/screenshot-cli.png?raw=true" width="682">
77
</p>
88

99
## Usage
1010

11+
To create a new Vue project using `create-vue`, simply run the following command in your terminal:
12+
1113
```sh
1214
npm create vue@latest
1315
```
1416

17+
> [!NOTE]
18+
> (`@latest` or `@legacy`) MUST NOT be omitted, otherwise `npm` may resolve to a cached and outdated version of the package.
19+
1520
Or, if you need to support IE11, you can create a Vue 2 project with:
1621

1722
```sh
1823
npm create vue@legacy
1924
```
2025

21-
Note that the tag name (`@latest` or `@legacy`) MUST NOT be omitted, otherwise `npm` may resolve to a cached and outdated version of the package.
26+
> [!WARNING]
27+
> [Vue 2 Has Reached End of Life](https://v2.vuejs.org/eol/)
2228
2329
## Difference from Vue CLI
2430

25-
- 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).
31+
- Vite-Powered: 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).
2632

27-
- Unlike Vue CLI, `create-vue` itself is just a scaffolding tool: it creates a pre-configured project based 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.
33+
- Scaffolding Tool: Unlike Vue CLI, `create-vue` itself is just a scaffolding tool: it creates a pre-configured project based 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.
2834

2935
## Migrating from Vue CLI
30-
31-
- [Vue CLI -> Vite Migration Guide from VueSchool.io](https://vueschool.io/articles/vuejs-tutorials/how-to-migrate-from-vue-cli-to-vite/)
32-
33-
- [Tools / Plugins that help with auto migration](https://github.com/vitejs/awesome-vite#vue-cli)
36+
If you're transitioning from Vue CLI to Create Vue, we've got you covered. Here are some resources to help you with the migration:
37+
How to Migrate from Vue CLI to Vite
38+
- Vue CLI to Vite Migration Guide: A comprehensive guide on migrating from Vue CLI to Vite, available on [VueSchool.io](https://vueschool.io/articles/vuejs-tutorials/how-to-migrate-from-vue-cli-to-vite/)
39+
- Tools and Plugins for Migration: For a smoother transition, check out the list of tools and plugins designed to assist with the migration process on the
40+
[Awesome Vite GitHub page](https://github.com/vitejs/awesome-vite#vue-cli).

media/screenshot-cli.png

140 KB
Loading

0 commit comments

Comments
 (0)