Package READMEs

Keep README.md files minimal; they must not contain documentation beyond simple starting points. Detailed documentation belongs exclusively in content/ and lives under https://ai-sdk.dev/docs.

Every package README.md file must contain the following, in the given order:

1. H1 (#) with a descriptive package title, not its npm identifier.
2. A 1–2 sentence description.
3. Optional note about compatibility, AI Gateway, or experimental nature. Consult similar packages and match their formatting; if in doubt, do not add one.
4. ## Setup: only one fenced, one-line npm i command, including necessary related packages.
5. ## Usage: only one fenced, basic getting-started code example (TypeScript or a framework component with TypeScript).
6. A suitable docs link using See the [<package title> documentation](<url>) for more information. If none clearly fits, use 1–2 related docs links with custom phrasing.

You must not include anything else in the readme. Any additional documentation belongs in content/.

Template

Omit the optional note when it does not apply.

# <Package Title>

A brief description of the package.

-> **Note**: <Optional compatibility or experimental notice.>

## Setup

```bash
npm i <npm-package>
```

## Usage

```ts
import { example } from '<npm-package>';

await example();
```

See the [<package title> documentation](https://ai-sdk.dev/...) for more information.

Exceptions

These packages have special-case README.md files and do not follow this format:

• ai
• codemod
• provider-utils
• provider

Never consult these files for which README.md conventions to follow.