Skip to content

Commit 96e3a2c

Browse files
committed
docs: add npx @superdoc-dev/create to root and npm READMEs
1 parent e5271c7 commit 96e3a2c

2 files changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,15 @@ Or use the CDN:
8080

8181
For all available options and events, see the [documentation](https://docs.superdoc.dev) or [SuperDoc.js](packages/superdoc/src/core/SuperDoc.js).
8282

83+
### Using an AI coding agent?
84+
85+
Set up your project for AI agents and configure the MCP server:
86+
87+
```bash
88+
npx @superdoc-dev/create # generates AGENTS.md for your framework
89+
claude mcp add superdoc -- npx @superdoc-dev/mcp # connect agent to DOCX files
90+
```
91+
8392
## Features
8493

8594
- **Real DOCX, not rich text** — Built on OOXML. Real pagination, section breaks, headers/footers. Not a contenteditable wrapper with export bolted on.

packages/superdoc/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,13 @@ const superdoc = new SuperDoc({
4242

4343
For React, Vue, and other frameworks, see the [documentation](https://docs.superdoc.dev).
4444

45+
### Using an AI coding agent?
46+
47+
```bash
48+
npx @superdoc-dev/create # generates AGENTS.md for your framework
49+
claude mcp add superdoc -- npx @superdoc-dev/mcp # connect agent to DOCX files
50+
```
51+
4552
## Documentation
4653

4754
[docs.superdoc.dev](https://docs.superdoc.dev) — installation, integration guides, collaboration setup, API reference, and more.

0 commit comments

Comments
 (0)