Skip to content

chores(fix): readme #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 8, 2025
Merged

chores(fix): readme #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AI SDK Simple Agents
# AI SDK Agents

[![NPM version](https://img.shields.io/npm/v/ai-sdk-agents.svg)](https://npmjs.org/package/ai-sdk-agents) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/facebook/react/blob/main/LICENSE) [![Actions Status](https://github.com/sslava/ai-sdk-agents/workflows/release/badge.svg)](https://github.com/sslava/ai-sdk-agents/actions)

Expand All @@ -17,31 +17,31 @@ A powerful and flexible library for building AI agents using the Vercel AI SDK.
## Installation

```bash
npm install ai-sdk-simple-agents
npm install ai-sdk-agents
# or
yarn add ai-sdk-simple-agents
yarn add ai-sdk-agents
# or
pnpm add ai-sdk-simple-agents
pnpm add ai-sdk-agents
```

## Prerequisites

This package requires the Vercel AI SDK and zod as a peer dependency:

```bash
npm install ai
npm install ai zod
# or
yarn add ai
yarn add ai zod
# or
pnpm add ai
pnpm add ai zod
```

## Usage

Here's a basic example of how to use the library:

```typescript
import { agent, ChatFlow, Context } from 'ai-sdk-simple-agents';
import { agent, ChatFlow, Context } from 'ai-sdk-agents';
import { openai } from '@ai-sdk/openai';

export type PlannerContext = Context & {
Expand Down
8 changes: 8 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@
"require": "./dist/*.cjs"
}
},
"repository": {
"type": "git",
"url": "git+https://github.com/sslava/ai-sdk-agents.git"
},
"bugs": {
"url": "https://github.com/sslava/ai-sdk-agents/issues"
},
"homepage": "https://github.com/sslava/ai-sdk-agents#readme",
"scripts": {
"build": "tsc && tsup",
"test": "vitest",
Expand Down