Skip to content

Commit

Permalink
add reedme (#141)
Browse files Browse the repository at this point in the history
  • Loading branch information
LittleLittleCloud authored Aug 30, 2024
1 parent d7622ee commit d0a67ab
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.

Expand Down
8 changes: 8 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit d0a67ab

Please sign in to comment.