Skip to content

Commit 819c818

Browse files
authored
Update README.md
1 parent 5bf6b61 commit 819c818

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

‎README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,42 @@
1-
# nuxt-ui-rules
1+
# AI rules
2+
3+
Use our AI rules to get the most out of Nuxt UI when using AI tools like Cursor, Windsurf, Claude Code, and others.
4+
5+
## Installation
6+
7+
You can download the latest version of Hugo's AI rules from the [rules folder](https://github.com/hugorcd/nuxt-ui-rules/blob/main/rules/nuxt-ui.md?plain=1). Copy and paste these into your prompts as needed, or set them up in your AI tool of choice.
8+
9+
## Using with Cursor
10+
11+
To add these rules to Cursor, create a new file at `.cursor/rules/nuxt-ui.mdc`, and add this header to the new file (adjusting the file extensions if necessary):
12+
13+
```md
14+
---
15+
name: nuxt-ui
16+
description: Best practices for using and upgrading Nuxt UI
17+
globs: ["**/*.{js,ts,jsx,tsx,mdx,css,html,vue,svelte,astro}"]
18+
tags:
19+
- nuxt-ui
20+
- nuxt
21+
- library
22+
- ui
23+
---
24+
```
25+
26+
Finally copy and paste the [rules](https://github.com/hugorcd/nuxt-ui-rules/blob/main/rules/nuxt-ui.md?plain=1) into the end of the file.
27+
28+
## Using with Claude Code
29+
30+
### Adding the rules as needed
31+
32+
If you want fine-grained control, store the [rules](https://github.com/hugorcd/nuxt-ui-rules/blob/main/rules/nuxt-ui.md?plain=1) in a dedicated rules folder like `rules/nuxt-ui.md`. Then, whenever you want to make your current Claude Code session an expert in Nuxt UI, `@`-mention the rules to make Claude read it:
33+
34+
```
35+
╭──────────────────────────────────────────────────────────────────────────────╮
36+
│ > read @rules/nuxt-ui.md and create a custom accordion │
37+
╰──────────────────────────────────────────────────────────────────────────────╯
38+
```
39+
40+
### Referencing in your CLAUDE.md file
41+
42+
Copy and paste the [rules](https://github.com/hugorcd/nuxt-ui-rules/blob/main/rules/nuxt-ui.md?plain=1) directly into your `CLAUDE.md` file. Claude Code will now read them for every new session.

0 commit comments

Comments
 (0)