From: Yordan Ramchev <69005114+Yordan-Ramchev@users.noreply.github.com>
Date: Mon, 29 Apr 2024 14:10:07 +0000 (+0300)
Subject: doc: update readme (#509)
X-Git-Tag: v3.10.4~21
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=95731cbf0b56d45c99251c27f8eb40e5914d816b;p=thirdparty%2Fvuejs%2Fcreate-vue.git

doc: update readme (#509)

update image and add warning message for vue 2 EOL

Fixes #503
---

diff --git a/README.md b/README.md
index 90699e51..3598ad4e 100644
--- a/README.md
+++ b/README.md
@@ -3,31 +3,38 @@
 The recommended way to start a Vite-powered Vue project
 
 <p align="center">
-  <img src="https://github.com/vuejs/create-vue/blob/main/media/screenshot-cli.png?raw=true" width="800">
+  <img src="https://github.com/vuejs/create-vue/blob/main/media/screenshot-cli.png?raw=true" width="752">
 </p>
 
 ## Usage
 
+To create a new Vue project using `create-vue`, simply run the following command in your terminal:
+
 ```sh
 npm create vue@latest
 ```
 
+> [!NOTE]
+>  (`@latest` or `@legacy`) MUST NOT be omitted, otherwise `npm` may resolve to a cached and outdated version of the package.
+
 Or, if you need to support IE11, you can create a Vue 2 project with:
 
 ```sh
 npm create vue@legacy
 ```
 
-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.
+> [!WARNING]
+> [Vue 2 Has Reached End of Life](https://v2.vuejs.org/eol/)
 
 ## 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).
+- 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).
 
-- 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.
+- 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.
 
 ## 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)
+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:
+How to Migrate from Vue CLI to Vite
+- 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/)
+- 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 
+[Awesome Vite GitHub page](https://github.com/vitejs/awesome-vite#vue-cli).
diff --git a/media/screenshot-cli.png b/media/screenshot-cli.png
index e81d6cb1..275ba1d4 100644
Binary files a/media/screenshot-cli.png and b/media/screenshot-cli.png differ