Skip to content

Commit 440cb6a

Browse files
chore: getting started section for README (#134)
1 parent bcf6b77 commit 440cb6a

File tree

1 file changed

+11
-25
lines changed

1 file changed

+11
-25
lines changed

README.md

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,17 @@ Nuxt Hints integrates directly into the Nuxt DevTools, giving you actionable ins
1111

1212
- [✨Release Notes](/CHANGELOG.md)
1313

14+
## Getting Started
15+
16+
To install and add the module, you can run the following command:
17+
18+
```bash
19+
npx nuxt module add hints
20+
```
21+
22+
The module is now automatically installed and added to your `nuxt.config.ts`.
23+
Now you can open your Nuxt app, go to the DevTools, and click the Nuxt Hints icon to get started.
24+
1425
## Features
1526

1627
- **🚀 Rich DevTools UI**: A dedicated tab in Nuxt DevTools to visualize issues, inspect elements, and get recommendations.
@@ -50,31 +61,6 @@ Analyze all third-party scripts on your page. The dashboard shows loading times,
5061

5162
![hints devtools third-party screenshot](./.github/assets/devtools-thirdparties.png)
5263

53-
## Quick Setup
54-
55-
1. Add `@nuxt/hints` dependency to your project:
56-
```bash
57-
# Using pnpm
58-
pnpm add -D @nuxt/hints
59-
60-
# Using yarn
61-
yarn add --dev @nuxt/hints
62-
63-
# Using npm
64-
npm install --save-dev @nuxt/hints
65-
```
66-
67-
2. Add `@nuxt/hints` to the `modules` section of `nuxt.config.ts`:
68-
```js
69-
export default defineNuxtConfig({
70-
modules: [
71-
'@nuxt/hints'
72-
]
73-
})
74-
```
75-
76-
That's it! Open your Nuxt app, go to the DevTools, and click the Nuxt Hints icon to get started.
77-
7864
## How It Works
7965

8066
### Performance Monitoring

0 commit comments

Comments
 (0)