Skip to content

Commit 841921a

Browse files
authored
Merge pull request #5 from sslava/readme-upd-2
chores(fix): readme
2 parents 7b62081 + 615c5cb commit 841921a

File tree

2 files changed

+16
-8
lines changed

2 files changed

+16
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AI SDK Simple Agents
1+
# AI SDK Agents
22

33
[![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)
44

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

1919
```bash
20-
npm install ai-sdk-simple-agents
20+
npm install ai-sdk-agents
2121
# or
22-
yarn add ai-sdk-simple-agents
22+
yarn add ai-sdk-agents
2323
# or
24-
pnpm add ai-sdk-simple-agents
24+
pnpm add ai-sdk-agents
2525
```
2626

2727
## Prerequisites
2828

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

3131
```bash
32-
npm install ai
32+
npm install ai zod
3333
# or
34-
yarn add ai
34+
yarn add ai zod
3535
# or
36-
pnpm add ai
36+
pnpm add ai zod
3737
```
3838

3939
## Usage
4040

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

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

4747
export type PlannerContext = Context & {

package.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@
3838
"require": "./dist/*.cjs"
3939
}
4040
},
41+
"repository": {
42+
"type": "git",
43+
"url": "git+https://github.com/sslava/ai-sdk-agents.git"
44+
},
45+
"bugs": {
46+
"url": "https://github.com/sslava/ai-sdk-agents/issues"
47+
},
48+
"homepage": "https://github.com/sslava/ai-sdk-agents#readme",
4149
"scripts": {
4250
"build": "tsc && tsup",
4351
"test": "vitest",

0 commit comments

Comments
 (0)