Skip to content

Commit 546d00d

Browse files
authored
fix: Update paths in example READMEs and move the READMEs to the client and server dirs (#148)
# Description Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [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 e97df4c commit 546d00d

File tree

3 files changed

+19
-7
lines changed

3 files changed

+19
-7
lines changed

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -336,15 +336,27 @@ AgentCard agentCard = A2A.getAgentCard("http://localhost:1234");
336336

337337
## Additional Examples
338338

339-
### Hello World Example
339+
### Hello World Client Example
340340

341-
A complete example of an A2A client communicating with a Python A2A server is available in the [examples/helloworld](examples/helloworld) directory. This example demonstrates:
341+
A complete example of a Java A2A client communicating with a Python A2A server is available in the [examples/helloworld/client](examples/helloworld/client/README.md) directory. This example demonstrates:
342342

343343
- Setting up and using the A2A Java client
344-
- Sending regular and streaming messages
345-
- Receiving and processing responses
344+
- Sending regular and streaming messages to a Python A2A server
345+
- Receiving and processing responses from the Python A2A server
346346

347-
The example includes detailed instructions on how to run both the Python server and the Java client using JBang. Check out the [example's README](examples/helloworld/client/src/main/java/io/a2a/examples/helloworld/README.md) for more information.
347+
The example includes detailed instructions on how to run the Python A2A server and how to run the Java A2A client using JBang.
348+
349+
Check out the [example's README](examples/helloworld/client/README.md) for more information.
350+
351+
### Hello World Server Example
352+
353+
A complete example of a Python A2A client communicating with a Java A2A server is available in the [examples/helloworld/server](examples/helloworld/server/README.md) directory. This example demonstrates:
354+
355+
- A sample `AgentCard` producer
356+
- A sample `AgentExecutor` producer
357+
- A Java A2A server receiving regular and streaming messages from a Python A2A client
358+
359+
Check out the [example's README](examples/helloworld/server/README.md) for more information.
348360

349361
## License
350362

examples/helloworld/client/src/main/java/io/a2a/examples/helloworld/README.md renamed to examples/helloworld/client/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ A JBang script is provided in the example directory to make running the client e
6262

6363
2. Navigate to the example directory:
6464
```bash
65-
cd examples/client/src/main/java/io/a2a/examples/helloworld
65+
cd examples/helloworld/client/src/main/java/io/a2a/examples/helloworld/
6666
```
6767

6868
3. Run the client using the JBang script:

examples/helloworld/server/src/main/java/io/a2a/examples/helloworld/README.md renamed to examples/helloworld/server/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This example demonstrates how to use the A2A Java SDK to communicate with an A2A
1414
The Java server can be started using `mvn` as follows:
1515

1616
```bash
17-
cd examples/server
17+
cd examples/helloworld/server
1818
mvn quarkus:dev
1919
```
2020

0 commit comments

Comments
 (0)