From d0a67abade6298d59ca5667440c352a8fc946463 Mon Sep 17 00:00:00 2001 From: Xiaoyun Zhang Date: Fri, 30 Aug 2024 15:05:38 -0700 Subject: [PATCH] add reedme (#141) --- README.md | 3 +-- example/README.md | 8 ++++++++ 2 files changed, 9 insertions(+), 2 deletions(-) create mode 100644 example/README.md diff --git a/README.md b/README.md index 9a52770..2be72e6 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@ ## 🌟 Highlights - **Multi-Agent WebUI**: Chat with multiple agents simultaneously in a web browser. +- **Code-First**: Use code-first approach to add agents to the chatroom, see [code-first examples](./example/README.md) for more information. - **Server mode**: You can run `ChatRoom.Client` as a restful server. For more information, see [Server mode](#-server-mode). - **API driven**: Use the `ChatRoom.SDK` to interact with the chatroom server programmatically. -- **Extensible**: Use code-first approach to add agents to the chatroom, See [Use AutoGen.Net agent](https://littlelittlecloud.github.io/Agent-ChatRoom/get_start/use_autogen_net_agent.html) for more information. ## Install from NuGet `Agent Chatroom` is published as a dotnet tool on nuget.org. You can install the latest `Agent Chatroom` client from nuget.org by running the following command, this will install the `ChatRoom.Client` globally: @@ -18,7 +18,6 @@ dotnet tool install --global ChatRoom.Client ``` - ## 🚀 Quick Start with template Writing configuration from scratch is painful, so `Agent Chatroom` provides a series of templates to help you get started quickly. Use the `list-templates` command to list all available templates and the `create` command to create a configuration from the selected template. diff --git a/example/README.md b/example/README.md new file mode 100644 index 0000000..2964d6d --- /dev/null +++ b/example/README.md @@ -0,0 +1,8 @@ +# Code-First Examples + +This folder contains code-first examples for `Agent-Chatroom` use cases, where you define agents in code first, then host and interact with them in a chatroom. + +## AutoGen.Net Examples +- [hello-world](./dotnet/hello-world): add a hello-world-agent to chatroom +- [weather-agent](./dotnet/weather-agent): add a weather-report agent to chatroom +- [agent-chatroom-release-room](./dotnet/gh-release-note-room): use github issue helper and gpt-4o to write release note for agent-chatroom project