Skip to content

Commit 9c1f3e8

Browse files
committed
docs: add version compatibility table to README
Add prominent version compatibility table showing which Redis OM Spring version to use with each Spring Boot version: - 1.0.x => Spring Boot 3.4.x - 1.1.x => Spring Boot 3.5.x - 2.0.x => Spring Boot 4.0.x Uses GitHub's [!IMPORTANT] callout syntax for visibility.
1 parent c28a1eb commit 9c1f3e8

File tree

1 file changed

+12
-28
lines changed

1 file changed

+12
-28
lines changed

README.md

Lines changed: 12 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -87,34 +87,18 @@ Redis OM Spring provides all Spring Data Redis capabilities, plus:
8787
- `@Vectorize` annotation to generate embeddings for text and images for use in Vector Similarity Searches
8888
- Vector Similarity Search API (See [Redis Stack Vectors](https://redis.io/docs/stack/search/reference/vectors/))
8989

90-
### 📋 Version Requirements
91-
92-
Redis OM Spring has the following version requirements:
93-
94-
| Dependency | Minimum Version | Recommended Version | Notes |
95-
|------------|----------------|-------------------|--------|
96-
| **Spring Boot** | 4.0.0 | 4.0.0 or later | Built with Spring Boot 4.0.0 |
97-
| **Spring Data Redis** | 4.0.0 | 4.0.0 or later | Aligned with Spring Boot version |
98-
| **Spring Framework** | 7.0.x | Latest 7.x | Transitive via Spring Boot |
99-
| **Jedis** | 7.0.0 | 7.0.0 or later | Redis Java client |
100-
| **Java** | 21 | 21 | Spring Boot 4.x requires Java 21+ |
101-
| **Redis Stack** | 7.2.x | 7.2.x or later | For JSON and Search modules |
102-
103-
#### Spring Boot Version Compatibility Policy
104-
105-
Redis OM Spring follows an **N-2 support policy** for Spring Boot versions:
106-
107-
- We build with the latest stable Spring Boot version
108-
- We support the current version and two previous minor versions that are still receiving OSS updates
109-
- We upgrade Spring Boot with each Redis OM Spring release
110-
111-
For example, as of Redis OM Spring 2.0.0:
112-
113-
- **Built with**: Spring Boot 4.0.0
114-
- **Minimum supported**: Spring Boot 4.0.0
115-
- **Recommended**: Spring Boot 4.0.0 or later
116-
117-
⚠️ **Note**: Using older Spring Boot versions may work but is not officially tested or supported. For production use, we recommend staying within the supported version range.
90+
> [!IMPORTANT]
91+
> ### 📋 Version Compatibility
92+
>
93+
> Choose the correct Redis OM Spring version for your Spring Boot version:
94+
>
95+
> | Redis OM Spring | Spring Boot | Java | Status |
96+
> |-----------------|-------------|------|--------|
97+
> | **1.0.x** | 3.4.x | 17+ | Maintenance |
98+
> | **1.1.x** | 3.5.x | 17+ | Current Stable |
99+
> | **2.0.x** | 4.0.x | 17+ | Latest |
100+
>
101+
> **Always use the Redis OM Spring version that matches your Spring Boot version.**
118102
119103
## 🏁 Getting Started
120104

0 commit comments

Comments
 (0)