From e7ee02d445ca3ef9ae7f3f34a4460a3fea19af8d Mon Sep 17 00:00:00 2001 From: Kelpejol <141008634+Kelpejol@users.noreply.github.com> Date: Fri, 26 Dec 2025 11:34:44 -1200 Subject: [PATCH] docs: add prerequisites section to README Adds prerequisites section aligned with Quick Start guide to help new users understand required tools before starting. This surfaces the prerequisites from our documentation directly in the README, reducing friction for first-time users. Signed-off-by: Kelpejol <141008634+Kelpejol@users.noreply.github.com> --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ae50df598..7aa9e72e7 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,27 @@ - [Quick Start](https://kagent.dev/docs/kagent/getting-started/quickstart) - [Installation guide](https://kagent.dev/docs/kagent/introduction/installation) +### Prerequisites + +To get started with kagent, you'll need: + +**Required Tools:** +- **[kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)** - For creating a local Kubernetes cluster +- **[kubectl](https://kubernetes.io/docs/tasks/tools/)** - For interacting with your cluster +- **[Helm](https://helm.sh/docs/intro/install/)** - For installing the kagent chart +- **[OpenAI API key](https://platform.openai.com/api-keys)** - For running AI agents (or use [Anthropic](https://console.anthropic.com/), [Ollama](https://ollama.ai/), etc.) + +**Quick verification:** +```bash +kind version +kubectl version --client +helm version +``` + +> **💡 Tip:** If you're planning to contribute code, see [DEVELOPMENT.md](DEVELOPMENT.md) for additional development tools. + +**Ready to start?** Follow our [Quick Start guide](https://kagent.dev/docs/kagent/getting-started/quickstart) to deploy your first agent in minutes! + ## Technical Details ### Core Concepts @@ -154,4 +175,4 @@ This project is licensed under the [Apache 2.0 License.](/LICENSE) Cloud Native Computing Foundation logo

kagent is a Cloud Native Computing Foundation project.

- \ No newline at end of file +