Skip to content

Commit f4292a9

Browse files
committed
changing readme.md
1 parent f620bb4 commit f4292a9

1 file changed

Lines changed: 11 additions & 19 deletions

File tree

README.md

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### Prerequisites
66

7-
- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) installed
7+
- An AI coding agent that supports plugins (e.g. [Claude Code](https://docs.anthropic.com/en/docs/claude-code))
88
- Node.js 18+
99
- [Bun](https://bun.sh)
1010

@@ -18,24 +18,14 @@ That's it. The plugin activates automatically — no setup, no commands to learn
1818

1919
### Option 2: Clone and build manually
2020

21-
#### 1. Clone and build
22-
2321
```bash
2422
git clone https://github.com/vercel-labs/vercel-plugin.git
2523
cd vercel-plugin
2624
bun install
2725
bun run build
2826
```
2927

30-
#### 2. Run Claude Code with the plugin
31-
32-
Navigate to any project you want to work on, then:
33-
34-
```bash
35-
claude --plugin-dir /path/to/vercel-plugin
36-
```
37-
38-
That's it. The plugin activates automatically — no setup, no commands to learn.
28+
Then point your AI agent at the plugin directory (e.g. `claude --plugin-dir /path/to/vercel-plugin` for Claude Code). The plugin activates automatically — no setup, no commands to learn.
3929

4030
#### Updating
4131

@@ -52,7 +42,7 @@ This plugin pre-loads AI agents with a **relational knowledge graph** of the ent
5242

5343
## How Do I Use This?
5444

55-
After installing, there's nothing to learn — all Vercel guidance happens automatically. The plugin detects what you're working on from your tool calls, file paths, and project config, then injects the right expertise at the right time. Just use Claude Code as you normally would and the plugin handles the rest.
45+
After installing, there's nothing to learn — all Vercel guidance happens automatically. The plugin detects what you're working on from your tool calls, file paths, and project config, then injects the right expertise at the right time. Just use your AI agent as you normally would and the plugin handles the rest.
5646

5747
## Components
5848

@@ -123,23 +113,25 @@ A text-form relational graph covering:
123113

124114
### Hooks
125115

126-
- **SessionStart context injection** — Injects `vercel.md` (ecosystem graph + conventions) into every session via a `SessionStart` hook
127-
- **SessionStart repo profiler** — Scans config files and dependencies to pre-prime `VERCEL_PLUGIN_LIKELY_SKILLS` for faster first tool call matching
128-
- **PreToolUse skill injection** — Matches tool calls to skills and injects SKILL.md content with dedup via `VERCEL_PLUGIN_SEEN_SKILLS` env var
116+
Currently implemented as [Claude Code hooks](https://docs.anthropic.com/en/docs/claude-code/hooks). We're actively working on making all hooks available to other major AI coding platforms.
117+
118+
- **SessionStart context injection** — Injects `vercel.md` (ecosystem graph + conventions) into every session
119+
- **SessionStart repo profiler** — Scans config files and dependencies to pre-prime skill matching for faster first tool call
120+
- **PreToolUse skill injection** — Matches tool calls to skills and injects relevant guidance with dedup
129121
- **Pre-write/edit validation** — Catches deprecated patterns before they're written (sunset packages, old API names, renamed files)
130122

131123
## Usage
132124

133125
```bash
134-
# Load directly for development
126+
# Claude Code example
135127
claude --plugin-dir ./vercel-plugin
136128

137-
# Invoke skills
129+
# Invoke skills via slash commands
138130
/vercel-plugin:nextjs
139131
/vercel-plugin:ai-sdk
140132
/vercel-plugin:deploy prod
141133

142-
# vercel.md is injected via SessionStart hook,
134+
# vercel.md is injected at session start,
143135
# giving the agent full Vercel context automatically.
144136
```
145137

0 commit comments

Comments
 (0)