Update README (#644)

* Update README with clearer setup instructions and direct links to getting started guides

* Update README.md

Co-authored-by: Tao Chen <taochen@microsoft.com>

---------

Co-authored-by: Tao Chen <taochen@microsoft.com>
This commit is contained in:
e-straight
2025-09-08 15:02:21 -07:00
committed by GitHub
Unverified
parent e8f1f4e785
commit 726eb66982
+15 -5
View File
@@ -4,15 +4,25 @@
You're getting early access to Microsoft's comprehensive multi-language framework for building, orchestrating, and deploying AI agents with support for both .NET and Python implementations. This framework provides everything from simple chat agents to complex multi-agent workflows with graph-based orchestration.
**A few important notes:**
- There currently are not public pypi or nuget packages for the SDKs. In order for the code and samples to work, please clone this repo and run the code here.
- The repo is an active project so make sure to sync regularly.
### 📋 Important Setup Information
**Package Availability:** Public PyPI and NuGet packages are not yet available. You have two options:
**We want your feedback!**
**Option 1: Run samples directly from this repository (no package installation needed)**
- Clone this repository
- For .NET: Run samples with `dotnet run` from any sample directory (e.g., `dotnet/samples/GettingStarted/Agents/Agent_Step01_Running`)
- For Python: Run samples from any sample directory (e.g., [`python/samples/getting_started/minimal_sample.py`](python/samples/getting_started/minimal_sample.py)) after setting up the local dev environment following this [guide](python/DEV_SETUP.md).
**Option 2: Install packages in your own project**
- **[.NET Getting Started Guide](./user-documentation-dotnet/getting-started/README.md)** - Instructions for using nightly packages
- **[Python Package Installation Guide](./user-documentation-python/getting-started/package_installation.md)** - Install packages directly from GitHub
**Stay Updated:** This is an active project - sync your local repository regularly to get the latest updates.
### 💬 **We want your feedback!**
- For bugs, please file a [GitHub issue](https://github.com/microsoft/agent-framework/issues).
- For feedback and suggestions for the team, please fill out [this survey](https://forms.office.com/Pages/ResponsePage.aspx?id=v4j5cvGGr0GRqy180BHbR9huAe5pW55CqgnnimXONJJUMlVMUzdCN1ZGOURXODlBSVJOSkxERVNCNS4u).
**Highlights**
### ✨ **Highlights**
- Flexible Agent Framework: build, orchestrate, and deploy AI agents and workflows
- Multi-Agent Orchestration: group chat, sequential, concurrent, and handoff patterns
- Graph-based Workflows: connect agents and deterministic functions using data flows with streaming, checkpointing, time-travel, and Human-in-the-loop.