Skip to content

docs: use new nuxi module add command in installation #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion docs/content/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
---
Expand Down
19 changes: 3 additions & 16 deletions docs/content/1.getting-started/1.setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:

Expand Down