You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update README and llms.txt for improved usage instructions
- Clarified the usage instructions for copying element context in the README.
- Added specific key combinations for Mac and Windows/Linux users.
- Enhanced the description of coding agent integration in the README for better understanding.
Copy file name to clipboardExpand all lines: README.md
+20-2Lines changed: 20 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
Select context for coding agents directly from your website
8
8
9
-
How? Point at any element and it'll send the file name, React component, and HTML source code.
9
+
How? Point at any element and press **⌘C** (Mac) or **Ctrl+C** (Windows/Linux) to copy the file name, React component, and HTML source code.
10
10
11
11
It makes tools like Cursor, Claude Code, Copilot run up to [**3× faster**](https://react-grab.com/blog/intro) and more accurate.
12
12
@@ -22,6 +22,22 @@ Run this command to install React Grab into your project. Ensure you are running
22
22
npx grab@latest init
23
23
```
24
24
25
+
## Usage
26
+
27
+
Once installed, hover over any UI element in your browser and press:
28
+
29
+
-**⌘C** (Cmd+C) on Mac
30
+
-**Ctrl+C** on Windows/Linux
31
+
32
+
This copies the element's context (file name, React component, and HTML source code) to your clipboard ready to paste into your coding agent. For example:
33
+
34
+
```js
35
+
<a class="ml-auto inline-block text-sm" href="#">
36
+
Forgot your password?
37
+
</a>
38
+
in LoginForm at components/login-form.tsx:46:19
39
+
```
40
+
25
41
## Manual Installation
26
42
27
43
If you're using a React framework or build tool, view instructions below:
@@ -124,7 +140,9 @@ if (process.env.NODE_ENV === "development") {
124
140
125
141
React Grab can send selected element context directly to your coding agent. This enables a workflow where you select a UI element and an agent automatically makes changes to your codebase.
126
142
127
-
This means **no copying and pasting** - just select the element and let the agent do the rest. [Learn more →](https://react-grab.com/blog/agent)
143
+
This means **no copying and pasting** - just select the element and let the agent do the rest. [Read more about coding agent integration →](https://react-grab.com/blog/agent)
144
+
145
+
> **Click to expand** setup instructions for your coding agent:
Copy file name to clipboardExpand all lines: packages/website/public/llms.txt
+17-1Lines changed: 17 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,22 @@
1
1
# React Grab
2
2
3
-
Grab any element in your app and give it to Cursor, Claude Code, or other AI coding agents. Hold ⌘C and click on any element to provide visual context directly to your AI assistant.
3
+
Grab any element in your app and give it to Cursor, Claude Code, or other AI coding agents.
4
+
5
+
## Usage
6
+
7
+
Once installed, hover over any UI element in your browser and press:
8
+
9
+
- **⌘C** (Cmd+C) on Mac
10
+
- **Ctrl+C** on Windows/Linux
11
+
12
+
This copies the element's context (file name, React component, and HTML source code) to your clipboard ready to paste into your coding agent. For example:
0 commit comments