From c3567a34a426814daab33ffc00601f5fc78bf162 Mon Sep 17 00:00:00 2001 From: Benjamin Canac Date: Mon, 17 Mar 2025 12:26:53 +0100 Subject: [PATCH] docs(installation): improve --- README.md | 17 ++++++++++++- .../1.getting-started/2.installation.md | 24 +++++++++++++++---- 2 files changed, 36 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8f1e32ef..0bb4a3de 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,22 @@ Read more on [ui2.nuxt.com](https://ui2.nuxt.com) ## Installation ```bash -npx nuxi@latest module add ui +# npm +npm install @nuxt/ui@2 +# yarn +yarn add @nuxt/ui@2 +# pnpm +pnpm add @nuxt/ui@2 +# bun +bun add @nuxt/ui@2 +``` + +Next, register the `@nuxt/ui` module in your `nuxt.config.ts`: + +```ts +export default defineNuxtConfig({ + modules: ['@nuxt/ui'] +}) ``` ## Documentation diff --git a/docs/content/1.getting-started/2.installation.md b/docs/content/1.getting-started/2.installation.md index 68352225..34622de6 100644 --- a/docs/content/1.getting-started/2.installation.md +++ b/docs/content/1.getting-started/2.installation.md @@ -7,13 +7,29 @@ description: 'Learn how to install and configure Nuxt UI in your application.' ### Add to a Nuxt project -1. Add `@nuxt/ui` module to your project: +1. Install the `@nuxt/ui` dependency in your project: -```bash -npx nuxi@latest module add ui +::code-group + +```bash [pnpm] +pnpm add @nuxt/ui@2 ``` -2. Add it to the `modules` section in your `nuxt.config.ts`: +```bash [yarn] +yarn add @nuxt/ui@2 +``` + +```bash [npm] +npm install @nuxt/ui@2 +``` + +```bash [bun] +bun add @nuxt/ui@2 +``` + +:: + +2. Register the `@nuxt/ui` module in your `nuxt.config.ts`: ```ts [nuxt.config.ts] export default defineNuxtConfig({