Skip to content

Commit 8329a62

Browse files
committed
Expand install section with Gradle, modules table, and prerequisites
The previous install block only covered Maven and the starter. Add a Gradle snippet alongside the Maven one, list every published module with its intended use case, and surface the Java/Spring Boot/Spring AI version requirements directly in the section instead of relying on the badges.
1 parent 8b73efe commit 8329a62

1 file changed

Lines changed: 32 additions & 1 deletion

File tree

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,11 @@ Real-world problems need **multiple agents working together**:
120120

121121
## Installation
122122

123-
Distributed via [JitPack](https://jitpack.io). Add the repository, then the starter:
123+
**Requirements:** Java 17+, Spring Boot 3.x, Spring AI 1.0+ (only when using `ExecutorAgent` or the starter).
124+
125+
Distributed via [JitPack](https://jitpack.io).
126+
127+
### Maven
124128

125129
```xml
126130
<repositories>
@@ -137,6 +141,33 @@ Distributed via [JitPack](https://jitpack.io). Add the repository, then the star
137141
</dependency>
138142
```
139143

144+
### Gradle
145+
146+
```groovy
147+
repositories {
148+
maven { url 'https://jitpack.io' }
149+
}
150+
151+
dependencies {
152+
implementation 'com.github.datallmhub.spring-ai-agents:spring-ai-agents-starter:v0.4.0'
153+
}
154+
```
155+
156+
### Modules
157+
158+
The starter pulls everything you typically need. Pick individual modules when
159+
you want a smaller footprint or run outside Spring Boot:
160+
161+
| Module | Use case |
162+
|---|---|
163+
| `spring-ai-agents-starter` | Spring Boot auto-config, properties, Micrometer listener |
164+
| `spring-ai-agents-core` | Minimal API (`Agent`, `AgentContext`, `StateKey`, `AgentResult`) |
165+
| `spring-ai-agents-graph` | `AgentGraph`, `RetryPolicy`, `CircuitBreakerPolicy` SPI, checkpoint contract |
166+
| `spring-ai-agents-squad` | `CoordinatorAgent`, `ExecutorAgent`, `ReActAgent`, `ParallelAgent`, `RoutingStrategy` |
167+
| `spring-ai-agents-checkpoint` | `JdbcCheckpointStore`, `RedisCheckpointStore`, Jackson codec |
168+
| `spring-ai-agents-resilience4j` | `CircuitBreakerPolicy` adapter backed by Resilience4j |
169+
| `spring-ai-agents-test` | `MockAgent`, `TestGraph` for unit-testing graphs |
170+
140171
The starter auto-configures everything. Minimal `application.yml`:
141172

142173
```yaml

0 commit comments

Comments
 (0)