Skip to content

Commit 5b74a24

Browse files
chore: add doc for version choose
1 parent 06d3419 commit 5b74a24

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

README-CN.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,11 @@
2828

2929
最新版本查阅:[这里](https://s01.oss.sonatype.org/#nexus-search;quick~alibabacloud-tairjedis-sdk)
3030
JavaDoc地址:[这里](https://javadoc.io/doc/com.aliyun.tair/alibabacloud-tairjedis-sdk/latest/index.html)
31-
31+
## 如何选择版本
32+
1. 3.x版本与5.x版本的区别是什么?
33+
> 3.x版本依赖Jedis 3.6.0版本,5.x版本依赖[valkey-java](https://github.com/valkey-io/valkey-java)的5.3.0版本,两者之间存在不兼容,详见[3to5-CN.md](https://github.com/tair-opensource/alibabacloud-tairjedis-sdk/blob/master/docs/3to5-CN.md)
34+
2. 我应该如何选择版本?
35+
> 如果您是新用户,建议直接使用最新的 5.x 版本,如果您已经使用了3.x版本,可以继续使用3.x最新版本,我们会保证功能相关的代码移植回去。
3236
# Example
3337
参考 [tests/example/*](https://github.com/alibaba/alibabacloud-tairjedis-sdk/tree/master/src/test/java/com/aliyun/tair/tests/example) 下完整示例。
3438

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,12 @@ A client packaged based on [Jedis](https://github.com/xetorthio/jedis) that oper
3030
```
3131

3232
The latest verison:[here](https://s01.oss.sonatype.org/#nexus-search;quick~alibabacloud-tairjedis-sdk)
33-
JavaDoc: [here](https://javadoc.io/doc/com.aliyun.tair/alibabacloud-tairjedis-sdk/latest/index.html)
33+
JavaDoc: [here](https://javadoc.io/doc/com.aliyun.tair/alibabacloud-tairjedis-sdk/latest/index.html)
34+
## How to choose the version
35+
1. What is the difference between 3.x and 5.x?
36+
> The difference between version 3.x and version 5.x is that version 3.x depends on Jedis version 3.6.0, and version 5.x depends on version 5.3.0 of [valkey-java](https://github.com/valkey-io/valkey-java). There is incompatibility between the two. For details, see [3to5.md](https://github.com/tair-opensource/alibabacloud-tairjedis-sdk/blob/master/docs/3to5.md).
37+
2. How should I choose the version?
38+
> If you are a new user, it is recommended to use the latest version 5.x directly. If you have already used version 3.x, you can continue to use the latest version of 3.x. We will ensure that the function-related code is ported back.
3439
3540
# Example
3641
Refer to the complete example under [tests/example/*](https://github.com/alibaba/alibabacloud-tairjedis-sdk/tree/master/src/test/java/com/aliyun/tair/tests/example)

0 commit comments

Comments
 (0)