Skip to content

Commit 1a67b65

Browse files
peterjEItanyaCopilot
authored
arrange the badges to the top, below the logo; update the readme (#576)
* arrange the badges to the top, below the logo; update the readme Signed-off-by: Peter Jausovec <peter.jausovec@solo.io> * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Eitan Yarmush <eitan.yarmush@solo.io> --------- Signed-off-by: Peter Jausovec <peter.jausovec@solo.io> Signed-off-by: Eitan Yarmush <eitan.yarmush@solo.io> Co-authored-by: Eitan Yarmush <eitan.yarmush@solo.io> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 4fb9da4 commit 1a67b65

File tree

1 file changed

+30
-36
lines changed

1 file changed

+30
-36
lines changed

README.md

Lines changed: 30 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -5,36 +5,39 @@
55
<img alt="kagent" src="https://raw.githubusercontent.com/kagent-dev/kagent/main/img/icon-light.svg">
66
</picture>
77
<div>
8+
<a href="https://github.com/kagent-dev/kagent/releases">
9+
<img src="https://img.shields.io/github/v/release/kagent-dev/kagent?style=flat&label=Latest%20version" alt="Release">
10+
</a>
11+
<a href="https://github.com/kagent-dev/kagent/actions/workflows/ci.yaml">
12+
<img src="https://github.com/kagent-dev/kagent/actions/workflows/ci.yaml/badge.svg" alt="Build Status" height="20">
13+
</a>
14+
<a href="https://opensource.org/licenses/Apache-2.0">
15+
<img src="https://img.shields.io/badge/License-Apache2.0-brightgreen.svg?style=flat" alt="License: Apache 2.0">
16+
</a>
17+
<a href="https://github.com/kagent-dev/kagent">
18+
<img src="https://img.shields.io/github/stars/kagent-dev/kagent.svg?style=flat&logo=github&label=Stars" alt="Stars">
19+
</a>
820
<a href="https://discord.gg/Fu3k65f2k3">
921
<img src="https://img.shields.io/discord/1346225185166065826?style=flat&label=Join%20Discord&color=6D28D9" alt="Discord">
1022
</a>
23+
<a href='https://codespaces.new/kagent-dev/kagent'>
24+
<img src='https://github.com/codespaces/badge.svg' alt='Open in Github Codespaces' style='max-width: 100%;' height="20">
25+
</a>
1126
</div>
1227
</div>
1328

1429
---
1530

16-
**kagent** is a Kubernetes native framework for building AI agents. Kubernetes is the most popular orchestration platform for running workloads, and **kagent** makes it easy to build, deploy and manage AI agents in kubernetes. The **kagent** framework is designed to be easy to understand and use, and to provide a flexible and powerful way to build and manage AI agents.
31+
**kagent** is a Kubernetes native framework for building AI agents. Kubernetes is the most popular orchestration platform for running workloads, and **kagent** makes it easy to build, deploy and manage AI agents in Kubernetes. The **kagent** framework is designed to be easy to understand and use, and to provide a flexible and powerful way to build and manage AI agents.
1732

1833
<div align="center">
1934
<img src="img/hero.png" alt="Autogen Framework" width="500">
2035
</div>
2136

22-
<!--latest build-->
23-
<a href="https://github.com/kagent-dev/kagent/actions/workflows/ci.yaml">
24-
<img src="https://github.com/kagent-dev/kagent/actions/workflows/ci.yaml/badge.svg" alt="Build Status" height="25">
25-
</a>
26-
2737
---
2838

2939
## Get started
3040

31-
<div align="center">
32-
<!--codespaces-->
33-
<a href='https://codespaces.new/kagent-dev/kagent'>
34-
<img src='https://github.com/codespaces/badge.svg' alt='Open in Github Codespaces' style='max-width: 100%;' height="26">
35-
</a>
36-
</div>
37-
3841
- [Quick Start](https://kagent.dev/docs/getting-started/quickstart)
3942
- [Installation guide](https://kagent.dev/docs/introduction/installation)
4043

@@ -45,10 +48,11 @@ The kagent documentation is available at [kagent.dev/docs](https://kagent.dev/do
4548

4649
## Core Concepts
4750

48-
- **Agents**: Agents are the main building block of kagent. They are a system prompt, a set of tools, and a model configuration.
49-
- **Tools**: Tools are any external tool that can be used by an agent. They are defined as Kubernetes custom resources and can be used by multiple agents.
50-
51-
All of the above are defined as Kubernetes custom resources, which makes them easy to manage and modify.
51+
- **Agents**: Agents are the main building block of kagent. They are a system prompt, a set of tools and agents, and an LLM configuration represented with a Kubernetes custom resource called "Agent".
52+
- **LLM Providers**: Kagent supports multiple LLM providers, including [OpenAI](https://kagent.dev/docs/supported-providers/openai), [Azure OpenAI](https://kagent.dev/docs/supported-providers/azure-openai), [Anthropic](https://kagent.dev/docs/supported-providers/anthropic), [Google Vertex AI](https://kagent.dev/docs/supported-providers/google-vertexai), [Ollama](https://kagent.dev/docs/supported-providers/ollama) and any other [custom providers and models](https://kagent.dev/docs/supported-providers/custom-models) accessible via AI gateways. Providers are represented by the ModelConfig resource.
53+
- **MCP Tools**: Agents can connect to any MCP server that provides tools. Kagent comes with an MCP server with tools for Kubernetes, Istio, Helm, Argo, Prometheus, Grafana, Cilium and others. All tools are as Kubernetes custom resources (ToolServers) and can be used by multiple agents.
54+
- **Memory**: Using the [memory](https://kagent.dev/docs/concepts/memory) your agents can always have access to the latest and most up to date information.
55+
- **Observability**: Kagent supports [OpenTelemetry tracing](https://kagent.dev/docs/getting-started/tracing) which allows you to monitor what's happening with your agents and tools.
5256

5357
## Core Principles
5458

@@ -74,27 +78,9 @@ Kagent has 4 core components:
7478
- **Engine**: The engine is a Python application that runs the agents and tools. The engine is built using [Autogen](https://github.com/microsoft/autogen).
7579
- **CLI**: The CLI is a command line tool that allows you to manage the agents and tools.
7680

77-
7881
## Roadmap
7982

80-
`kagent` is currently in active development. The following is a list of features that are planned for the next few releases.
81-
82-
- [ ] [Observability improvements:](https://github.com/kagent-dev/kagent/issues/130)
83-
- [ ] More powerful Tracing capabilities
84-
- [ ] Tighter oTEL integration
85-
- [ ] Metrics
86-
- [ ] [Feedback/Testing:](https://github.com/kagent-dev/kagent/issues/131)
87-
- [ ] Eval framework/integrations
88-
- [ ] Debugging/Time travel
89-
- [ ] Guided Learning
90-
- [ ] [Runtime/Engine improvements:](https://github.com/kagent-dev/kagent/issues/132)
91-
- [ ] Multi-Agent support
92-
- [ ] True Graph Execution
93-
- [ ] Workflows
94-
- [x] Multiple LLM Provider support
95-
- [ ] [Tools:](https://github.com/kagent-dev/kagent/issues/133)
96-
- [x] Tool Discovery
97-
- [x] Expose built-in tools as MCP server
83+
`kagent` is currently in active development. You can check out the full roadmap in the project Kanban board [here](https://github.com/orgs/kagent-dev/projects/3).
9884

9985
## Local development
10086

@@ -103,3 +89,11 @@ For instructions on how to run everything locally, see the [DEVELOPMENT.md](DEVE
10389
## Contributing
10490

10591
For instructions on how to contribute to the kagent project, see the [CONTRIBUTION.md](CONTRIBUTION.md) file.
92+
93+
## Contributors
94+
95+
Thanks to all contributors who are helping to make kagent better.
96+
97+
<a href="https://github.com/kagent-dev/kagent/graphs/contributors">
98+
<img src="https://contrib.rocks/image?repo=kagent-dev/kagent" />
99+
</a>

0 commit comments

Comments
 (0)