From 9211e0308aea69e74fcaf4341e9ee23fba1966bd Mon Sep 17 00:00:00 2001 From: Daniel Roe Date: Wed, 3 Apr 2024 13:50:17 +0100 Subject: [PATCH] docs: use new `nuxi module add` command in installation --- README.md | 9 +-------- docs/content/0.index.md | 2 +- docs/content/1.getting-started/1.setup.md | 19 +++---------------- 3 files changed, 5 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 20fdffb..5b0a864 100644 --- a/README.md +++ b/README.md @@ -24,14 +24,7 @@ Run lightweight, heavily customizable particle simulations in your Nuxt project 1. Add the `nuxt-particles` dependency to your project ```bash -# Using pnpm -pnpm add -D nuxt-particles - -# Using yarn -yarn add --dev nuxt-particles - -# Using npm -npm install --save-dev nuxt-particles +npx nuxi@latest module add particles ``` 2. Add `nuxt-particles` to the `modules` section of `nuxt.config.ts` diff --git a/docs/content/0.index.md b/docs/content/0.index.md index b94f187..187cf6f 100644 --- a/docs/content/0.index.md +++ b/docs/content/0.index.md @@ -37,7 +37,7 @@ Run lightweight, heavily customizable particle simulations in your Nuxt project ::terminal --- content: - - pnpm i -D nuxt-particles + - npx nuxi@latest module add particles - Add 'nuxt-particles' to your 'modules' array in 'nuxt.config.ts' - Profit! --- diff --git a/docs/content/1.getting-started/1.setup.md b/docs/content/1.getting-started/1.setup.md index 097de76..a81773c 100644 --- a/docs/content/1.getting-started/1.setup.md +++ b/docs/content/1.getting-started/1.setup.md @@ -5,22 +5,9 @@ This module is plug-and-play with sensible defaults. Just install the package to ## Installation 1. Install the `nuxt-particles` package: - -::code-group - - ```bash [pnpm] - pnpm add -D nuxt-particles - ``` - - ```bash [yarn] - yarn add -D nuxt-particles - ``` - - ```bash [npm] - npm install --save-dev nuxt-particles - ``` - -:: +```bash +npx nuxi@latest module add particles +``` 2. Add the `nuxt-particles` package to the `modules` array in your `nuxt.config.ts`: