Skip to content

Commit 8e48e93

Browse files
committed
Update README to clarify Redis version support
1 parent 4b2729c commit 8e48e93

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<a href="https://github.com/swift-server/sswg/blob/master/process/incubation.md#sandbox-level"><img src="https://img.shields.io/badge/sswg-sandbox-lightgrey.svg" alt="SSWG Maturity"></a>
77
<a href="https://gitlab.com/Mordil/swift-redi-stack/blob/master/LICENSE.txt"><img src="https://img.shields.io/badge/License-Apache%202.0-yellow.svg" alt="Apache 2 License"></a>
88
<a href="https://swift.org"><img src="https://img.shields.io/badge/Swift-5.0+-orange.svg" alt="Swift 5.0+"></a>
9-
<a href="https://redis.io"><img src="https://img.shields.io/badge/Redis-5.0+-red.svg" alt="Redis 5.0+"></a>
9+
<a href="https://redis.io"><img src="https://img.shields.io/badge/Redis-5.0-red.svg" alt="Redis 5.0"></a>
1010
</p>
1111
</div>
1212

@@ -20,11 +20,15 @@ The <a href="https://github.com/Mordil/swift-redi-stack" rel="nofollow noreferre
2020

2121
It communicates over the network using Redis' [**Re**dis **S**eralization **P**rotocol (RESP2)](https://redis.io/topics/protocol).
2222

23+
This library is primarily developed for Redis v5, but is backwards compatible to Redis v3**¹**.
24+
2325
The table below lists the major releases alongside their compatible language, dependency, and Redis versions.
2426

25-
| SPM Version | [Swift](https://swift.org/download) | [Redis](https://redis.io) | [SwiftNIO](https://github.com/apple/swift-nio) | [SwiftLog](https://github.com/apple/swift-log) | [SwiftMetrics](https://github.com/apple/swift-metrics) |
26-
|:---:|:---:|:---:|:---:|:---:|:---:|
27-
| `from: "1.0.0-alpha.5"` | 5.0+ | 5.0+ | 2.x | 1.x | 1.x |
27+
| RediStack Release | [Swift](https://swift.org/download) | [Redis](https://redis.io) | [SwiftNIO](https://github.com/apple/swift-nio) | [SwiftLog](https://github.com/apple/swift-log) | [SwiftMetrics](https://github.com/apple/swift-metrics) |
28+
|:-----------------:|:-----------------------------------:|:-------------------------:|:----------------------------------------------:|:----------------------------------------------:|:------------------------------:|
29+
| `from: "1.0.0-alpha.7"` | 5.0+ | 3.x**¹** < 6.x | 2.x | 1.x | 1.x |
30+
31+
> **¹** _Use of newer Redis features on older Redis versions is done at your own risk. See Redis' release notes for [v5](https://raw.githubusercontent.com/antirez/redis/5.0/00-RELEASENOTES), [v4](https://raw.githubusercontent.com/antirez/redis/4.0/00-RELEASENOTES), and [v3](https://raw.githubusercontent.com/antirez/redis/3.0/00-RELEASENOTES) for what is supported for each version of Redis._
2832
2933
### Supported Operating Systems
3034

0 commit comments

Comments
 (0)