Skip to content

Commit 3e15279

Browse files
authored
fix: Update the README following the module re-organization (#169)
# Description This PR updates the README following the module re-org changes. - [x] Follow the [`CONTRIBUTING` Guide](../CONTRIBUTING.md). - [x] Make your Pull Request title in the <https://www.conventionalcommits.org/> specification. - Important Prefixes for [release-please](https://github.com/googleapis/release-please): - `fix:` which represents bug fixes, and correlates to a [SemVer](https://semver.org/) patch. - `feat:` represents a new feature, and correlates to a SemVer minor. - `feat!:`, or `fix!:`, `refactor!:`, etc., which represent a breaking change (indicated by the `!`) and will result in a SemVer major. - [x] Ensure the tests pass - [x] Appropriate READMEs were updated (if necessary)
1 parent 2c5af01 commit 3e15279

File tree

2 files changed

+21
-38
lines changed

2 files changed

+21
-38
lines changed

README.md

Lines changed: 21 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -29,26 +29,34 @@ More examples will be added soon.
2929

3030
The A2A Java SDK provides a Java server implementation of the [Agent2Agent (A2A) Protocol](https://google-a2a.github.io/A2A). To run your agentic Java application as an A2A server, simply follow the steps below.
3131

32-
- [Add the A2A Java SDK Core Maven dependency to your project](#1-add-the-a2a-java-sdk-core-maven-dependency-to-your-project)
32+
- [Add an A2A Java SDK Server Maven dependency to your project](#1-add-an-a2a-java-sdk-server-maven-dependency-to-your-project)
3333
- [Add a class that creates an A2A Agent Card](#2-add-a-class-that-creates-an-a2a-agent-card)
3434
- [Add a class that creates an A2A Agent Executor](#3-add-a-class-that-creates-an-a2a-agent-executor)
35-
- [Add an A2A Java SDK Server Maven dependency to your project](#4-add-an-a2a-java-sdk-server-maven-dependency-to-your-project)
3635

37-
### 1. Add the A2A Java SDK Maven dependencies to your project
36+
### 1. Add an A2A Java SDK Server Maven dependency to your project
3837

39-
> **Note**: The A2A Java SDK isn't available yet in Maven Central but will be soon. For now, be
40-
> sure to check out the latest tag (you can see the tags [here](https://github.com/a2aproject/a2a-java/tags)), build from the tag, and reference that version below. For example, if the latest tag is `0.2.3`, you can use the following dependency.
38+
Adding a dependency on an A2A Java SDK Server will provide access to the core classes that make up the A2A specification
39+
and allow you to run your agentic Java application as an A2A server agent.
40+
41+
The A2A Java SDK provides two A2A server endpoint implementations, one based on Jakarta REST (`a2a-java-sdk-server-jakarta`) and one based on Quarkus Reactive Routes (`a2a-java-sdk-server-quarkus`). You can choose the one that best fits your application.
42+
43+
Add **one** of the following dependencies to your project:
4144

4245
```xml
4346
<dependency>
4447
<groupId>io.a2a.sdk</groupId>
45-
<artifactId>a2a-java-sdk-client</artifactId>
46-
<version>0.2.3</version>
48+
<artifactId>a2a-java-sdk-server-jakarta</artifactId>
49+
<version>${io.a2a.sdk.version}</version>
4750
</dependency>
51+
```
52+
53+
OR
54+
55+
```xml
4856
<dependency>
4957
<groupId>io.a2a.sdk</groupId>
50-
<artifactId>a2a-java-sdk-server-common</artifactId>
51-
<version>0.2.3</version>
58+
<artifactId>a2a-java-sdk-server-quarkus</artifactId>
59+
<version>${io.a2a.sdk.version}</version>
5260
</dependency>
5361
```
5462

@@ -185,39 +193,19 @@ public class WeatherAgentExecutorProducer {
185193
}
186194
```
187195

188-
### 4. Add an A2A Java SDK Server Maven dependency to your project
189-
190-
> **Note**: The A2A Java SDK isn't available yet in Maven Central but will be soon. For now, be
191-
> sure to check out the latest tag (you can see the tags [here](https://github.com/a2aproject/a2a-java/tags)), build from the tag, and reference that version below. For example, if the latest tag is `0.2.3`, you can use the following dependency.
192-
193-
Adding a dependency on an A2A Java SDK Server will allow you to run your agentic Java application as an A2A server.
194-
195-
The A2A Java SDK provides two A2A server endpoint implementations, one based on Jakarta REST (`a2a-java-sdk-server-jakarta`) and one based on Quarkus Reactive Routes (`a2a-java-sdk-server-quarkus`). You can choose the one that best fits your application.
196-
197-
Add **one** of the following dependencies to your project:
198-
199-
```xml
200-
<dependency>
201-
<groupId>io.a2a.sdk</groupId>
202-
<artifactId>a2a-java-sdk-server-jakarta</artifactId>
203-
<version>${io.a2a.sdk.version}</version>
204-
</dependency>
205-
```
196+
## A2A Client
206197

207-
OR
198+
The A2A Java SDK provides a Java client implementation of the [Agent2Agent (A2A) Protocol](https://google-a2a.github.io/A2A), allowing communication with A2A servers.
199+
To make use of the Java `A2AClient`, simply add the following dependency:
208200

209201
```xml
210202
<dependency>
211203
<groupId>io.a2a.sdk</groupId>
212-
<artifactId>a2a-java-sdk-server-quarkus</artifactId>
204+
<artifactId>a2a-java-sdk-client</artifactId>
213205
<version>${io.a2a.sdk.version}</version>
214206
</dependency>
215207
```
216208

217-
## A2A Client
218-
219-
The A2A Java SDK provides a Java client implementation of the [Agent2Agent (A2A) Protocol](https://google-a2a.github.io/A2A), allowing communication with A2A servers.
220-
221209
### Sample Usage
222210

223211
#### Create an A2A client

tck/pom.xml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,6 @@
1616
<description>Server example to use with the A2A TCK</description>
1717

1818
<dependencies>
19-
<dependency>
20-
<groupId>io.a2a.sdk</groupId>
21-
<artifactId>a2a-java-sdk-spec</artifactId>
22-
<version>${project.version}</version>
23-
</dependency>
2419
<dependency>
2520
<groupId>io.a2a.sdk</groupId>
2621
<artifactId>a2a-java-sdk-server-quarkus</artifactId>

0 commit comments

Comments
 (0)