Skip to content

Commit a46a092

Browse files
authored
Merge pull request #7 from agntcy/docs/crate-readmes
docs: add crate readmes for crates.io
2 parents 7bbc219 + 2fc3d66 commit a46a092

File tree

10 files changed

+146
-0
lines changed

10 files changed

+146
-0
lines changed

a2a-client/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
name = "agntcy-a2a-client"
33
version = "0.1.3"
44
description = "A2A v1 async client with protocol binding factory"
5+
readme = "README.md"
56
edition.workspace = true
67
license.workspace = true
78
repository.workspace = true

a2a-client/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# agntcy-a2a-client
2+
3+
Async Rust client for A2A v1 agents.
4+
5+
This crate is published as `agntcy-a2a-client` and imported in Rust as `a2a_client`.
6+
7+
## What It Provides
8+
9+
- REST and JSON-RPC transports
10+
- Agent card resolution and transport selection helpers
11+
- A high-level `A2AClient` wrapper
12+
- Streaming response parsing for SSE-based endpoints
13+
14+
## Install
15+
16+
```toml
17+
[dependencies]
18+
a2a = { package = "agntcy-a2a", version = "0.2" }
19+
a2a-client = { package = "agntcy-a2a-client", version = "0.1" }
20+
```
21+
22+
## Workspace
23+
24+
This crate is part of the `a2a-rs` workspace.
25+
26+
- Repository: https://github.com/agntcy/a2a-rs
27+
- Workspace README: https://github.com/agntcy/a2a-rs/blob/main/README.md

a2a-grpc/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
name = "agntcy-a2a-grpc"
33
version = "0.1.0"
44
description = "A2A v1 gRPC protocol binding for client and server"
5+
readme = "README.md"
56
edition.workspace = true
67
license.workspace = true
78
repository.workspace = true

a2a-grpc/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# agntcy-a2a-grpc
2+
3+
gRPC bindings for A2A v1 client and server implementations.
4+
5+
This crate is published as `agntcy-a2a-grpc` and imported in Rust as `a2a_grpc`.
6+
7+
## What It Provides
8+
9+
- Tonic-based client transport bindings
10+
- Tonic service adapters for A2A request handlers
11+
- Conversion glue between native models and protobuf messages
12+
13+
## Install
14+
15+
```toml
16+
[dependencies]
17+
a2a = { package = "agntcy-a2a", version = "0.2" }
18+
a2a-grpc = { package = "agntcy-a2a-grpc", version = "0.1" }
19+
```
20+
21+
## Workspace
22+
23+
This crate is part of the `a2a-rs` workspace.
24+
25+
- Repository: https://github.com/agntcy/a2a-rs
26+
- Workspace README: https://github.com/agntcy/a2a-rs/blob/main/README.md

a2a-pb/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
name = "agntcy-a2a-pb"
33
version = "0.1.0"
44
description = "A2A v1 protobuf-generated types and conversion layer"
5+
readme = "README.md"
56
edition.workspace = true
67
license.workspace = true
78
repository.workspace = true

a2a-pb/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# agntcy-a2a-pb
2+
3+
Protobuf schema and conversion helpers for A2A v1.
4+
5+
This crate is published as `agntcy-a2a-pb` and imported in Rust as `a2a_pb`.
6+
7+
## What It Provides
8+
9+
- Generated protobuf types for the A2A schema
10+
- Conversion helpers between protobuf and native Rust models
11+
- The bundled A2A proto definition used by the Rust workspace
12+
13+
## Install
14+
15+
```toml
16+
[dependencies]
17+
a2a = { package = "agntcy-a2a", version = "0.2" }
18+
a2a-pb = { package = "agntcy-a2a-pb", version = "0.1" }
19+
```
20+
21+
## Workspace
22+
23+
This crate is part of the `a2a-rs` workspace.
24+
25+
- Repository: https://github.com/agntcy/a2a-rs
26+
- Workspace README: https://github.com/agntcy/a2a-rs/blob/main/README.md

a2a-server/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
name = "agntcy-a2a-server"
33
version = "0.1.0"
44
description = "A2A v1 async server framework"
5+
readme = "README.md"
56
edition.workspace = true
67
license.workspace = true
78
repository.workspace = true

a2a-server/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# agntcy-a2a-server
2+
3+
Async server framework for implementing A2A v1 agents in Rust.
4+
5+
This crate is published as `agntcy-a2a-server` and imported in Rust as `a2a_server`.
6+
7+
## What It Provides
8+
9+
- REST and JSON-RPC routers built on `axum`
10+
- A transport-agnostic `RequestHandler` abstraction
11+
- A default handler and in-memory task store
12+
- SSE helpers for streaming task responses
13+
14+
## Install
15+
16+
```toml
17+
[dependencies]
18+
a2a = { package = "agntcy-a2a", version = "0.2" }
19+
a2a-server = { package = "agntcy-a2a-server", version = "0.1" }
20+
```
21+
22+
## Workspace
23+
24+
This crate is part of the `a2a-rs` workspace.
25+
26+
- Repository: https://github.com/agntcy/a2a-rs
27+
- Workspace README: https://github.com/agntcy/a2a-rs/blob/main/README.md

a2a/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
name = "agntcy-a2a"
33
version = "0.2.0"
44
description = "A2A v1 protocol types and core definitions"
5+
readme = "README.md"
56
edition.workspace = true
67
license.workspace = true
78
repository.workspace = true

a2a/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# agntcy-a2a
2+
3+
Core Rust types for the A2A v1 protocol.
4+
5+
This crate is published as `agntcy-a2a` and imported in Rust as `a2a`.
6+
7+
## What It Provides
8+
9+
- A2A wire-compatible message, task, artifact, and event types
10+
- JSON-RPC request and response models
11+
- Protocol error types and helpers
12+
- Serde implementations aligned with the A2A protocol shape
13+
14+
## Install
15+
16+
```toml
17+
[dependencies]
18+
a2a = { package = "agntcy-a2a", version = "0.2" }
19+
```
20+
21+
## Example
22+
23+
```rust
24+
use a2a::{Message, Part, Role};
25+
26+
let message = Message::new(Role::User, vec![Part::text("hello")]);
27+
assert_eq!(message.text(), Some("hello"));
28+
```
29+
30+
## Workspace
31+
32+
This crate is part of the `a2a-rs` workspace.
33+
34+
- Repository: https://github.com/agntcy/a2a-rs
35+
- Workspace README: https://github.com/agntcy/a2a-rs/blob/main/README.md

0 commit comments

Comments
 (0)