From 5c069cca8f10727cd3a053b7284b2775871b6c9e Mon Sep 17 00:00:00 2001 From: Hangfei Lin Date: Tue, 22 Apr 2025 18:18:44 -0700 Subject: [PATCH] chore: Update README.md (#353) add instruction about our releases. --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ffb36fc..ca33433 100644 --- a/README.md +++ b/README.md @@ -45,12 +45,27 @@ debugging, versioning, and deployment anywhere – from your laptop to the cloud ## 🚀 Installation -You can install the ADK using `pip`: +### Stable Release (Recommended) + +You can install the latest stable version of ADK using `pip`: ```bash pip install google-adk ``` +The release cadence is weekly. + +This version is recommended for most users as it represents the most recent official release. + +### Development Version +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: + +```bash +pip install git+https://github.com/google/adk-python.git@main +``` + +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. + ## 📚 Documentation Explore the full documentation for detailed guides on building, evaluating, and