Skip to content

Commit e605367

Browse files
committed
Fix README links
1 parent 813ed13 commit e605367

2 files changed

Lines changed: 24 additions & 19 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<a href="https://linear.app" target="_blank" rel="noopener noreferrer">
2+
<a href="https://plot.day" target="_blank" rel="noopener noreferrer">
33
<img width="48" height="48" alt="favicon" src="https://github.com/user-attachments/assets/f38501fd-bb37-4671-a0bc-fd35fa25360d" alt="Plot logo" />
44
</a>
55
</p>
@@ -13,7 +13,7 @@
1313

1414
## Packages
1515

16-
- **[@plotday/agent](./agent)** - Core agent builder package with the `plot` command, agent and tool SDK, and built-in tools
16+
- **[@plotday/agent](./builder)** - Core agent builder package with the `plot` command, agent and tool SDK, and built-in tools
1717
- **[tools/](./tools)** - Additional tools for building agents, including integrations with popular services
1818
- **[agents/](./agents)** - Full source code for several agents
1919

@@ -35,11 +35,11 @@ npm run deploy
3535

3636
## Documentation
3737

38-
See the [Plot Agent Builder documentation](https://build.plot.day) for detailed guides and API reference.
38+
See the [Agent Builder documentation](https://build.plot.day) for detailed guides and API reference.
3939

4040
## Changelog
4141

42-
See the [builder changelog](./agent/CHANGELOG.md) for version history and release notes.
42+
See the [Agent Builder changelog](./builder/CHANGELOG.md) for version history and release notes.
4343

4444
## License
4545

builder/README.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,6 @@
1515
<a href="https://build.plot.day"><strong>📚 Full Documentation →</strong></a>
1616
</p>
1717

18-
---
19-
20-
> **⚠️ DEPRECATED:** This package has been renamed to **@plotday/agent**. Please use [@plotday/agent](https://www.npmjs.com/package/@plotday/agent) instead.
21-
22-
---
23-
2418
## Quick Start
2519

2620
Choose your path:
@@ -38,6 +32,7 @@ Create agents using natural language - no programming required!
3832
# My Calendar Agent
3933

4034
I want an agent that:
35+
4136
- Syncs my Google Calendar events into Plot
4237
- Creates tasks for upcoming meetings
4338
- Sends reminders 10 minutes before meetings
@@ -65,7 +60,12 @@ npx @plotday/agent create
6560
**2. Implement your agent:**
6661

6762
```typescript
68-
import { Agent, ActivityType, type Priority, type ToolBuilder } from "@plotday/agent";
63+
import {
64+
ActivityType,
65+
Agent,
66+
type Priority,
67+
type ToolBuilder,
68+
} from "@plotday/agent";
6969
import { Plot } from "@plotday/agent/tools/plot";
7070

7171
export default class MyAgent extends Agent<MyAgent> {
@@ -113,6 +113,7 @@ async upgrade() // When new version is deployed
113113
Tools provide capabilities to agents. Use built-in tools or create your own.
114114

115115
**Built-in Tools:**
116+
116117
- **Plot** - Manage activities and priorities
117118
- **Store** - Persistent key-value storage
118119
- **AI** - Language models with structured output
@@ -131,11 +132,13 @@ The core data type representing tasks, events, and notes.
131132
await this.tools.plot.createActivity({
132133
type: ActivityType.Task,
133134
title: "Review pull request",
134-
links: [{
135-
type: ActivityLinkType.external,
136-
title: "View PR",
137-
url: "https://github.com/org/repo/pull/123"
138-
}]
135+
links: [
136+
{
137+
type: ActivityLinkType.external,
138+
title: "View PR",
139+
url: "https://github.com/org/repo/pull/123",
140+
},
141+
],
139142
});
140143
```
141144

@@ -169,6 +172,7 @@ plot priority create # Create new priority
169172
**[📚 Full Documentation at build.plot.day](https://build.plot.day)**
170173

171174
### Guides
175+
172176
- [Getting Started](https://build.plot.day/GETTING_STARTED.html) - Complete walkthrough
173177
- [Core Concepts](https://build.plot.day/CORE_CONCEPTS.html) - Agents, tools, and architecture
174178
- [Built-in Tools](https://build.plot.day/TOOLS_GUIDE.html) - Plot, Store, AI, and more
@@ -177,6 +181,7 @@ plot priority create # Create new priority
177181
- [Advanced Topics](https://build.plot.day/ADVANCED.html) - Complex patterns and techniques
178182

179183
### Reference
184+
180185
- [CLI Reference](https://build.plot.day/CLI_REFERENCE.html) - Complete command documentation
181186
- [API Reference](https://build.plot.day) - TypeDoc-generated API docs
182187

@@ -195,7 +200,7 @@ export default class WelcomeAgent extends Agent<WelcomeAgent> {
195200
async activate(priority: Pick<Priority, "id">) {
196201
await this.tools.plot.createActivity({
197202
type: ActivityType.Note,
198-
title: "Welcome to Plot! 👋"
203+
title: "Welcome to Plot! 👋",
199204
});
200205
}
201206
}
@@ -209,8 +214,8 @@ export default class GitHubAgent extends Agent<GitHubAgent> {
209214
return {
210215
plot: build(Plot),
211216
network: build(Network, {
212-
urls: ['https://api.github.com/*']
213-
})
217+
urls: ["https://api.github.com/*"],
218+
}),
214219
};
215220
}
216221

0 commit comments

Comments
 (0)