Skip to content

Commit 3faf5b1

Browse files
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
1 parent cd9fe7d commit 3faf5b1

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,20 @@ Official Java SDK for [AxonFlow](https://getaxonflow.com) - AI Governance Platfo
66
[![Maven Central](https://img.shields.io/maven-central/v/com.getaxonflow/axonflow-sdk.svg)](https://search.maven.org/artifact/com.getaxonflow/axonflow-sdk)
77
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
88

9+
## How This SDK Fits with AxonFlow
10+
11+
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.
12+
13+
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.
14+
15+
### Architecture Overview (2 min)
16+
17+
If you're new to AxonFlow, this short video shows how the control plane and SDKs work together in a real production setup:
18+
19+
[![AxonFlow Architecture Overview](https://img.youtube.com/vi/WwQXHKuZhxc/maxresdefault.jpg)](https://youtu.be/WwQXHKuZhxc)
20+
21+
▶️ [Watch on YouTube](https://youtu.be/WwQXHKuZhxc)
22+
923
## Requirements
1024

1125
- Java 11 or higher

0 commit comments

Comments
 (0)