Skip to content

Commit 14d5d65

Browse files
some readme updates (#19)
* checkpoint * big woo energy * Update README.md * Update README.md * Update README.md * Update README.md * more readme edits
1 parent cf434f8 commit 14d5d65

File tree

4 files changed

+403
-219
lines changed

4 files changed

+403
-219
lines changed

README.md

Lines changed: 61 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,74 @@
11
# 🧠 Cloudflare Agents
22

3-
🚧 **Work in Progress** 🚧
3+
![agents-header](https://github.com/user-attachments/assets/f6d99eeb-1803-4495-9c5e-3cf07a37b402)
44

5-
A collection of examples and tools for building AI agents that run on Cloudflare Workers. The goal is to make it easy to build stateful, long-running agents that can communicate in real-time and run at the edge.
5+
_This project is in active development. Join us in shaping the future of intelligent agents._
66

7-
## Current Status
7+
Welcome to a new paradigm in AI development. Cloudflare Agents provides the foundation for building intelligent, stateful agents that persist, think, and evolve at the edge of the network.
88

9-
This is an early-stage project. We're currently building out:
9+
## Vision
1010

11-
- Example implementations
12-
- Documentation and guides
13-
- A core agent framework
11+
We're creating a framework where AI agents can:
1412

15-
Stay tuned for updates!
13+
- Maintain persistent state and memory
14+
- Engage in real-time communication
15+
- Process and learn from interactions
16+
- Operate autonomously at global scale
17+
- Hibernate when idle, awaken when needed
18+
19+
## Project Status
20+
21+
This project is actively evolving. Current focus areas:
22+
23+
### Ready for Use
24+
25+
- Core agent framework with state management
26+
- Real-time WebSocket communication
27+
- HTTP endpoints and routing
28+
- React integration hooks
29+
- Basic AI chat capabilities
30+
31+
### In Development
32+
33+
- Advanced memory systems
34+
- WebRTC for audio/video
35+
- Email integration
36+
- Evaluation framework
37+
- Enhanced observability
38+
- Self-hosting guide
1639

1740
## Getting Started
1841

19-
Check out the `/examples` directory for current implementations. Each example has its own README with setup instructions.
42+
### Quick Start
43+
44+
```bash
45+
# Create a new project
46+
npm create cloudflare@latest -- --template agents
47+
48+
# Or add to existing project
49+
npm install @cloudflare/agents
50+
```
51+
52+
## Documentation
53+
54+
For comprehensive documentation and guides:
55+
56+
- [Core Framework](packages/agents/README.md)
57+
- [The Anthropic Patterns for building effective agents](guides/anthropic-patterns/README.md)
58+
- [Human in the Loop](guides/humans-in-the-loop/README.md)
59+
- [Playground](examples/playground/README.md)
60+
61+
## Contributing
62+
63+
We welcome contributions! Whether it's:
64+
65+
- New examples
66+
- Documentation improvements
67+
- Bug fixes
68+
- Feature suggestions
2069

2170
## License
2271

23-
MIT License - feel free to use and adapt as needed.
72+
MIT License - Build something meaningful.
73+
74+
---

docs/index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
- get started
2+
- add to an existing project
3+
- routing
4+
- human in the loop
5+
- control flow
6+
- state
7+
- sync-engine
8+
- ai-sdk
9+
- tools
10+
- other stacks
11+
- http/ws
12+
- email
13+
- a/v
14+
- scheduling
15+
- pause/resume
16+
- memory
17+
- evals
18+
- observability
19+
- connect anything
20+
- self hosting
21+
- how is this different from durable objects?
22+
- resources / read more

examples/playground/README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,35 @@
1-
## agents playground
1+
# Agent Playground
22

3-
Just a bunch of trials for stuff.
3+
A collection of interactive examples demonstrating core agent capabilities.
4+
5+
## Running the Examples
6+
7+
```bash
8+
# Install dependencies
9+
npm install
10+
11+
# Start the development server
12+
npm start
13+
```
14+
15+
Visit `localhost:5173` to explore the examples.
16+
17+
## Examples
18+
19+
### State Synchronization
20+
21+
Demonstrates real-time state synchronization across multiple clients:
22+
23+
- Counter with shared state
24+
- Text input synchronization
25+
- Color picker with live updates
26+
- Multi-window synchronization
27+
28+
### Temporal Patterns
29+
30+
Shows how agents can schedule and manage tasks over time:
31+
32+
- Immediate actions (10-second intervals)
33+
- Daily scheduled tasks
34+
- Cron-based scheduling
35+
- Future date scheduling

0 commit comments

Comments
 (0)