From 97fa0ed9801a04af3653ccd393d0b557db7970a9 Mon Sep 17 00:00:00 2001 From: Saurabh Jain Date: Thu, 15 Jan 2026 21:42:00 +0100 Subject: [PATCH] docs: add architecture overview section to README - Clarify that SDK requires a deployed AxonFlow platform - Add 2-minute architecture video link - Explain how SDK fits with the control plane --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index af7c73f..676438f 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,20 @@ Enterprise AI Governance in 3 Lines of Code. [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Type hints](https://img.shields.io/badge/type%20hints-mypy-brightgreen.svg)](http://mypy-lang.org/) +## How This SDK Fits with AxonFlow + +This SDK is a client library for interacting with a running AxonFlow control plane. It is used from application or agent code to send execution context, policies, and requests at runtime. + +A deployed AxonFlow platform (self-hosted or cloud) is required for end-to-end AI governance. SDKs alone are not sufficient—the platform and SDKs are designed to be used together. + +### Architecture Overview (2 min) + +If you're new to AxonFlow, this short video shows how the control plane and SDKs work together in a real production setup: + +[![AxonFlow Architecture Overview](https://img.youtube.com/vi/WwQXHKuZhxc/maxresdefault.jpg)](https://youtu.be/WwQXHKuZhxc) + +▶️ [Watch on YouTube](https://youtu.be/WwQXHKuZhxc) + ## Installation ```bash