From c602a1e20f516ba0a85a9bf0a0e63b4fc1d4c04a Mon Sep 17 00:00:00 2001 From: Karel Cemus Date: Sun, 12 Nov 2023 00:22:48 +0100 Subject: [PATCH] Improved documentation and changelog (#267) * Improved documentation for #262 * Improved readme, prepared for next major release and update to Play 2.9 --- README.md | 21 +++++++++++---------- doc/40-migration.md | 7 +++++++ 2 files changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2baaf29..f52b50d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # Redis Cache module for Play framework - **This version supports Play framework 2.8.x with JDK 8 and both Scala 2.12 and Scala 2.13.**
+ **This version supports Play framework 2.9.x with JDK 17 and both Scala 2.13 and Scala 3.**
**For previous versions see older releases.** [![Travis CI: Status](https://travis-ci.org/KarelCemus/play-redis.svg?branch=master)](https://travis-ci.org/KarelCemus/play-redis) @@ -14,7 +14,7 @@ ## About the Project -[Play framework 2](https://playframework.com/) is delivered with +[Play framework](https://playframework.com/) is delivered with [SyncCacheApi and AsyncCacheApi](https://playframework.com/documentation/2.8.x/ScalaCache). This module provides **implementation of a cache over Redis** server, i.e., key/value storage. @@ -130,14 +130,15 @@ libraryDependencies += "com.github.karelcemus" %% "play-redis" % "2.7.0" ## Compatibility matrix -| play framework | play-redis | documentation | -|-----------------|---------------:|-----------------:| -| 2.8.x | 2.7.0 | [see here](https://github.com/KarelCemus/play-redis/blob/2.7.0/README.md) | -| 2.7.x | 2.5.1 | [see here](https://github.com/KarelCemus/play-redis/blob/2.5.1/README.md) | -| 2.6.x | 2.3.0 | [see here](https://github.com/KarelCemus/play-redis/blob/2.3.0/README.md) ([Migration Guide](https://github.com/KarelCemus/play-redis/blob/2.3.0/doc/40-migration.md)) | -| 2.5.x | 1.4.2 | [see here](https://github.com/KarelCemus/play-redis/blob/1.4.2/README.md) | -| 2.4.x | 1.0.0 | [see here](https://github.com/KarelCemus/play-redis/blob/1.0.0/README.md) | -| 2.3.x | 0.2.1 | [see here](https://github.com/KarelCemus/play-redis/blob/0.2.1/README.md) | +| play framework | play-redis | documentation | +|----------------|---------------------------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| 2.9.x | 3.0.0 | [see here](https://github.com/KarelCemus/play-redis/blob/3.0.0/README.md) | +| 2.8.x | 2.7.0 | [see here](https://github.com/KarelCemus/play-redis/blob/2.7.0/README.md) | +| 2.7.x | 2.5.1 | [see here](https://github.com/KarelCemus/play-redis/blob/2.5.1/README.md) | +| 2.6.x | 2.3.0 | [see here](https://github.com/KarelCemus/play-redis/blob/2.3.0/README.md) ([Migration Guide](https://github.com/KarelCemus/play-redis/blob/2.3.0/doc/40-migration.md)) | +| 2.5.x | 1.4.2 | [see here](https://github.com/KarelCemus/play-redis/blob/1.4.2/README.md) | +| 2.4.x | 1.0.0 | [see here](https://github.com/KarelCemus/play-redis/blob/1.0.0/README.md) | +| 2.3.x | 0.2.1 | [see here](https://github.com/KarelCemus/play-redis/blob/0.2.1/README.md) | ## Contribution diff --git a/doc/40-migration.md b/doc/40-migration.md index a3e5540..24bcbf5 100644 --- a/doc/40-migration.md +++ b/doc/40-migration.md @@ -9,6 +9,13 @@ backward compatibility in a few places. This Migration Guide allows you to adjus in the smoothest possible way. We believe that removing technical debt as soon as possible is the only way of keeping this project in a good shape. + +## Migration from 2.8.x to 3.0.x + +Migrated to Play 2.9.0 and increased minimal version of JDK to 17. + +Dropped support for Scala 2.12, compiled against Scala 2.13.12 to be usable with Scala 3. + ## Migration from 2.0.x to 2.1.x The most changes are under the hood, however, there are couple