Skip to content

Commit 19c9455

Browse files
boyangsvlcopybara-github
authored andcommitted
chore: Add content from 1.x back to 2.x README.md
Also updated the ADK web screenshot and added a video demo link. Co-authored-by: Bo Yang <ybo@google.com> PiperOrigin-RevId: 964158202
1 parent ae5118d commit 19c9455

3 files changed

Lines changed: 86 additions & 2 deletions

File tree

README.md

Lines changed: 86 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
[![PyPI downloads](https://static.pepy.tech/badge/google-adk/month)](https://pepy.tech/project/google-adk)
77
[![Continuous Integration](https://github.com/google/adk-python/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/google/adk-python/actions/workflows/continuous-integration.yml)
88
[![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://google.github.io/adk-docs/)
9+
[![r/agentdevelopmentkit](https://img.shields.io/badge/Reddit-r%2Fagentdevelopmentkit-FF4500?style=flat&logo=reddit&logoColor=white)](https://www.reddit.com/r/agentdevelopmentkit/)
10+
<a href="https://codewiki.google/github.com/google/adk-python"><img src="https://www.gstatic.com/_/boq-sdlc-agents-ui/_/r/Mvosg4klCA4.svg" alt="Ask Code Wiki" height="20"></a>
911

1012
<h2 align="center">
1113
<img src="https://raw.githubusercontent.com/google/adk-python/main/assets/agent-development-kit.png" width="256"/>
@@ -19,6 +21,19 @@
1921
<a href="https://github.com/google/adk-samples">Samples</a> &
2022
<a href="https://github.com/google/adk-web">ADK Web</a>.
2123
</h3>
24+
<h3 align="center">
25+
ADK in other languages:
26+
<a href="https://github.com/google/adk-java">ADK Java</a>,
27+
<a href="https://github.com/google/adk-kotlin">ADK Kotlin</a>,
28+
<a href="https://github.com/google/adk-go">ADK Go</a> &
29+
<a href="https://github.com/google/adk-js">ADK Typescript</a>.
30+
</h3>
31+
32+
Agent Development Kit (ADK) is a flexible and modular framework that applies
33+
software development principles to AI agent creation. It is designed to
34+
simplify building, deploying, and orchestrating agent workflows, from simple
35+
tasks to complex systems. While optimized for Gemini, ADK is model-agnostic,
36+
deployment-agnostic, and compatible with other frameworks.
2237

2338
______________________________________________________________________
2439

@@ -30,7 +45,7 @@ ______________________________________________________________________
3045
3146
______________________________________________________________________
3247

33-
## 🔥 What's New in 2.0
48+
## ✨ Key Features
3449

3550
- **Workflow Runtime**: A graph-based execution engine for composing
3651
deterministic execution flows for agentic apps, with support for routing,
@@ -41,8 +56,30 @@ ______________________________________________________________________
4156
mode, single-turn controlled output, mixed delegation patterns,
4257
human-in-the-loop, and task agents as workflow nodes.
4358

59+
- **Modular Multi-Agent Systems**: Design scalable applications by composing
60+
multiple specialized agents into flexible hierarchies.
61+
62+
- **Rich Tool Ecosystem**: Utilize pre-built tools, custom functions,
63+
OpenAPI specs, MCP tools or integrate existing tools to give agents diverse
64+
capabilities, all for tight integration with the Google ecosystem.
65+
66+
- **Code-First Development**: Define agent logic, tools, and orchestration
67+
directly in Python for ultimate flexibility, testability, and versioning.
68+
69+
- **Agent Config**: Build agents without code. Check out the
70+
[Agent Config](https://google.github.io/adk-docs/agents/config/) feature.
71+
72+
- **Tool Confirmation**: A [tool confirmation flow(HITL)](https://google.github.io/adk-docs/tools/confirmation/) that can guard tool execution with explicit confirmation and custom input.
73+
74+
- **Deploy Anywhere**: Easily containerize and deploy agents on Cloud Run or
75+
scale seamlessly with Vertex AI Agent Engine.
76+
4477
## 🚀 Installation
4578

79+
### Stable Release (Recommended)
80+
81+
You can install the latest stable version of ADK using `pip`:
82+
4683
```bash
4784
pip install google-adk
4885
```
@@ -69,6 +106,16 @@ pip install "google-adk[extensions]"
69106

70107
The release cadence is roughly bi-weekly.
71108

109+
### Development Version
110+
111+
Bug fixes and new features are merged into the main branch on GitHub first. If you need access to changes that haven't been included in an official PyPI release yet, you can install directly from the main branch:
112+
113+
```bash
114+
pip install git+https://github.com/google/adk-python.git@main
115+
```
116+
117+
Note: The development version is built directly from the latest code commits. While it includes the newest fixes and features, it may also contain experimental changes or bugs not present in the stable release. Use it primarily for testing upcoming changes or accessing critical fixes before they are officially released.
118+
72119
## Quick Start
73120

74121
> **Beginner Note:** ADK applications are built using two main classes:
@@ -118,6 +165,22 @@ adk run path/to/my_agent
118165
adk web path/to/agents_dir
119166
```
120167

168+
### Development UI
169+
170+
A built-in development UI to help you test, evaluate, debug, and showcase your agent(s).
171+
172+
[![ADK Web UI](https://raw.githubusercontent.com/google/adk-python/main/assets/adk-web-dev-ui.png)](https://youtu.be/TEjqk0eeNy8)
173+
174+
[![Watch on YouTube](https://img.shields.io/badge/YouTube-Watch%20ADK%20Web%20Demo-FF0000?style=flat&logo=youtube&logoColor=white)](https://youtu.be/TEjqk0eeNy8)
175+
176+
### Evaluate Agents
177+
178+
```bash
179+
adk eval \
180+
samples_for_testing/hello_world \
181+
samples_for_testing/hello_world/hello_world_eval_set_001.evalset.json
182+
```
183+
121184
## 📚 Documentation
122185

123186
- **Getting Started**: https://google.github.io/adk-docs/
@@ -131,9 +194,30 @@ adk web path/to/agents_dir
131194

132195
## 🤝 Contributing
133196

134-
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
197+
We welcome contributions from the community! Whether it's bug reports, feature requests, documentation improvements, or code contributions, please see our:
198+
199+
- [General contribution guideline and flow](https://google.github.io/adk-docs/contributing-guide/).
200+
- [Code Contributing Guidelines](./CONTRIBUTING.md) to get started.
201+
202+
## Community Repo
203+
204+
We have [adk-python-community repo](https://github.com/google/adk-python-community) that is home to a growing ecosystem of community-contributed tools, third-party
205+
service integrations, and deployment scripts that extend the core capabilities
206+
of the ADK.
207+
208+
## Vibe Coding
209+
210+
If you want to develop agent via vibe coding the [llms.txt](./llms.txt) and the [llms-full.txt](./llms-full.txt) can be used as context to LLM. While the former one is a summarized one and the later one has the full information in case your LLM has big enough context window.
211+
212+
## Community Events
213+
214+
- [Completed] ADK's 1st community meeting on Wednesday, October 15, 2025. Remember to [join our group](https://groups.google.com/g/adk-community) to get access to the [recording](https://drive.google.com/file/d/1rpXDq5NSH8-MyMeYI6_5pZ3Lhn0X9BQf/view), and [deck](https://docs.google.com/presentation/d/1_b8LG4xaiadbUUDzyNiapSFyxanc9ZgFdw7JQ6zmZ9Q/edit?slide=id.g384e60cdaca_0_658&resourcekey=0-tjFFv0VBQhpXBPCkZr0NOg#slide=id.g384e60cdaca_0_658).
135215

136216
## 📄 License
137217

138218
This project is licensed under the Apache 2.0 License — see the
139219
[LICENSE](LICENSE) file for details.
220+
221+
______________________________________________________________________
222+
223+
*Happy Agent Building!*
-213 KB
Loading

assets/adk-web-dev-ui.png

200 KB
Loading

0 commit comments

Comments
 (0)