From 57d8727d4dbb2dac7a73b353170b9dc26ba4351d Mon Sep 17 00:00:00 2001 From: skirtle <65301168+skirtles-code@users.noreply.github.com> Date: Fri, 15 Dec 2023 06:14:29 +0000 Subject: [PATCH] docs: expand installation.md (#2071) --- packages/docs/installation.md | 42 ++++++++++++++++++++++++++++++----- 1 file changed, 37 insertions(+), 5 deletions(-) diff --git a/packages/docs/installation.md b/packages/docs/installation.md index 5503d5ce..6677e33b 100644 --- a/packages/docs/installation.md +++ b/packages/docs/installation.md @@ -12,14 +12,46 @@ -## npm +This will expose Vue Router via a global `VueRouter` object, e.g. `VueRouter.createRouter(...)`. -```bash +## Package managers + +If you have an existing project that uses a JavaScript package manager, you can install Vue Router from the npm registry: + +::: code-group + +```bash [npm] npm install vue-router@4 ``` -## yarn - -```bash +```bash [yarn] yarn add vue-router@4 ``` + +```bash [pnpm] +pnpm add vue-router@4 +``` + +::: + +If you're starting a new project, you might find it easier to use the [create-vue](https://github.com/vuejs/create-vue) scaffolding tool, which creates a Vite-based project with the option to include Vue Router: + +::: code-group + +```bash [npm] +npm create vue@latest +``` + +```bash [yarn] +yarn create vue +``` + +```bash [pnpm] +pnpm create vue +``` + +::: + +You'll be prompted with some questions about the kind of project you want to create. If you choose to install Vue Router, the example application will also demonstrate some of Vue Router's core features. + +Projects using package managers will typically use ES modules to access Vue Router, e.g. `import { createRouter } from 'vue-router'`. \ No newline at end of file -- 2.47.2