From abcd6b2fd6646676fa2eb0b6de0e856deac1a38c Mon Sep 17 00:00:00 2001 From: Alexander Lichter Date: Fri, 14 Nov 2025 11:03:50 +0100 Subject: [PATCH] chore: getting started section for README --- README.md | 36 +++++++++++------------------------- 1 file changed, 11 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 2d5cb5b..8ee6bbf 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,17 @@ Nuxt Hints integrates directly into the Nuxt DevTools, giving you actionable ins - [✨Release Notes](/CHANGELOG.md) +## Getting Started + +To install and add the module, you can run the following command: + +```bash +npx nuxt module add hints +``` + +The module is now automatically installed and added to your `nuxt.config.ts`. +Now you can open your Nuxt app, go to the DevTools, and click the Nuxt Hints icon to get started. + ## Features - **🚀 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, ![hints devtools third-party screenshot](./.github/assets/devtools-thirdparties.png) -## Quick Setup - -1. Add `@nuxt/hints` dependency to your project: - ```bash - # Using pnpm - pnpm add -D @nuxt/hints - - # Using yarn - yarn add --dev @nuxt/hints - - # Using npm - npm install --save-dev @nuxt/hints - ``` - -2. Add `@nuxt/hints` to the `modules` section of `nuxt.config.ts`: - ```js - export default defineNuxtConfig({ - modules: [ - '@nuxt/hints' - ] - }) - ``` - -That's it! Open your Nuxt app, go to the DevTools, and click the Nuxt Hints icon to get started. - ## How It Works ### Performance Monitoring