Skip to content

Commit be7f8f1

Browse files
committed
docs: polish README for max conversion and star traction
1 parent 67e1fad commit be7f8f1

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ System.out.println(result.text());
3737

3838
👉 No loops. No routing logic. Just agents collaborating.
3939

40+
> **This is a multi-step, stateful workflow with routing, coordination, and resilience — without writing orchestration code.**
41+
4042
---
4143

4244
## 🧠 Why this exists
@@ -45,10 +47,10 @@ Real-world AI systems are not one LLM call.
4547

4648
They are:
4749

48-
- multi-step
49-
- stateful
50-
- failure-prone
51-
- long-running
50+
- **multi-step**
51+
- **stateful**
52+
- **failure-prone**
53+
- **long-running**
5254

5355
Spring AI gives you primitives.
5456
**spring-agent-flow gives you a runtime.**
@@ -59,6 +61,8 @@ Spring AI gives you primitives.
5961

6062
![How it works](docs/images/demo.png)
6163

64+
> A coordinator routes tasks across agents, executing a graph with shared state, retries, and checkpoints.
65+
6266
---
6367

6468
## 🧭 When should I use this?
@@ -70,7 +74,7 @@ Spring AI gives you primitives.
7074
- failures (retry, resume, rate limits) matter
7175
- multiple agents must coordinate
7276

73-
**Don't use it if:**
77+
**Avoid it if:**
7478

7579
- you just call `ChatClient` once
7680

@@ -104,7 +108,7 @@ spring-agent-flow gives you:
104108

105109
---
106110

107-
## 🚀 Try it now (no LLM required)
111+
## 🚀 Try it in 30 seconds (no API key required)
108112

109113
```bash
110114
git clone https://github.com/datallmhub/spring-agent-flow.git
@@ -113,6 +117,8 @@ mvn install -DskipTests -q
113117
mvn -pl spring-agent-flow-samples exec:java
114118
```
115119

120+
👉 Runs a real multi-agent workflow with routing, coordination, and state — fully simulated.
121+
116122
## 📦 Samples included
117123

118124
The project ships with ready-to-run examples — no LLM required.
@@ -123,6 +129,8 @@ The project ships with ready-to-run examples — no LLM required.
123129
| `MinimalPipeline` | Simple 2-step workflow using AgentGraph | `-Dexec.mainClass="...MinimalPipeline"` |
124130
| `AdvancedGraphDemo` | Loops, conditions, state, listeners | `-Dexec.mainClass="...AdvancedGraphDemo"` |
125131

132+
👉 Start with `MultiAgentCoordination` — it demonstrates the full power of the framework.
133+
126134
Run all samples:
127135

128136
```bash
@@ -133,6 +141,7 @@ mvn -pl spring-agent-flow-samples exec:java
133141

134142
## 🧩 What you get
135143

144+
- ⚡ No orchestration code required
136145
- 🧠 Stateful agent workflows
137146
- 🔁 Built-in retries & circuit breakers
138147
- 📊 Graph-based execution

0 commit comments

Comments
 (0)