From 0a70d558f2e18d3b0fc26f367a4629af5b638ec7 Mon Sep 17 00:00:00 2001 From: Karel Cemus Date: Sun, 4 Feb 2024 23:49:03 +0100 Subject: [PATCH] Documentation updated to version 3.0.0-M2 (#276) --- CHANGELOG.md | 2 ++ README.md | 40 ++++++++++++++++++++-------------------- doc/10-integration.md | 2 +- doc/20-configuration.md | 2 +- doc/40-migration.md | 4 ++-- 5 files changed, 26 insertions(+), 24 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a34f7a0..90dcfe1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,8 @@ for cluster are using fixed port mapping and tests for sentinel are disabled sin that sentinel implementation is not fully reliable, therefore sentinel is not officially supported at this moment. [#273](https://github.com/KarelCemus/play-redis/pull/273) +Installed linters and formatters - scalafmt, scalafix, wartremover. [#275](https://github.com/KarelCemus/play-redis/pull/275) + ### [:link: 2.7.0](https://github.com/KarelCemus/play-redis/tree/2.7.0) SET command supports milliseconds, previous versions used seconds [#247](https://github.com/KarelCemus/play-redis/issues/247) diff --git a/README.md b/README.md index 24f10bd..96b20fe 100644 --- a/README.md +++ b/README.md @@ -36,22 +36,22 @@ as well as on your premise. - [synchronous and asynchronous APIs](#provided-apis) - [implements standard APIs defined by Play's `cacheApi` project](#provided-apis) -- support of [named caches](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#named-caches) -- [works with Guice](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/40-migration.md#runtime-time-dependency-injection) as well as [compile-time DI](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/40-migration.md#compile-time-dependency-injection) -- [getOrElse and getOrFuture operations](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/30-how-to-use.md#use-of-cacheapi) easing the use -- [wildcards in remove operation](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/30-how-to-use.md#use-of-cacheapi) -- support of collections: [sets](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/30-how-to-use.md#use-of-sets), [lists](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/30-how-to-use.md#use-of-lists), and [maps](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/30-how-to-use.md#use-of-maps) -- [increment and decrement operations](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/30-how-to-use.md#use-of-cacheapi) -- [eager and lazy invocation policies](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#eager-and-lazy-invocation) waiting or not waiting for the result -- several [recovery policies](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#recovery-policy) and possibility of further customization -- support of [several configuration sources](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#running-in-different-environments) +- support of [named caches](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/20-configuration.md#named-caches) +- [works with Guice](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/40-migration.md#runtime-time-dependency-injection) as well as [compile-time DI](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/40-migration.md#compile-time-dependency-injection) +- [getOrElse and getOrFuture operations](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/30-how-to-use.md#use-of-cacheapi) easing the use +- [wildcards in remove operation](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/30-how-to-use.md#use-of-cacheapi) +- support of collections: [sets](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/30-how-to-use.md#use-of-sets), [lists](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/30-how-to-use.md#use-of-lists), and [maps](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/30-how-to-use.md#use-of-maps) +- [increment and decrement operations](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/30-how-to-use.md#use-of-cacheapi) +- [eager and lazy invocation policies](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/20-configuration.md#eager-and-lazy-invocation) waiting or not waiting for the result +- several [recovery policies](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/20-configuration.md#recovery-policy) and possibility of further customization +- support of [several configuration sources](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/20-configuration.md#running-in-different-environments) - static in the configuration file - from the connection string optionally in the environmental variable - custom implementation of the configuration provider -- support of [standalone, cluster,](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#standalone-vs-cluster) - [aws-cluster,](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#aws-cluster) - and [sentinel modes](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#sentinel) -- build on the top of Akka actors and serializers, [agnostic to the serialization mechanism](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#limitation-of-data-serialization) +- support of [standalone, cluster,](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/20-configuration.md#standalone-vs-cluster) + [aws-cluster,](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/20-configuration.md#aws-cluster) + and [sentinel modes](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/20-configuration.md#sentinel) +- build on the top of Akka actors and serializers, [agnostic to the serialization mechanism](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/20-configuration.md#limitation-of-data-serialization) - for simplicity, it uses deprecated Java serialization by default - it is recommended to use [Kryo library](https://github.com/romix/akka-kryo-serialization) or any other mechanism @@ -92,11 +92,11 @@ or you can use shortcuts in the table below. To use this module: -1. [Add this library into your project](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/10-integration.md) and expose APIs -1. See the [configuration options](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md) -1. [Browse examples of use](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/30-how-to-use.md) +1. [Add this library into your project](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/10-integration.md) and expose APIs +1. See the [configuration options](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/20-configuration.md) +1. [Browse examples of use](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/30-how-to-use.md) -If you come from older version, you might check the [Migration Guide](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/40-migration.md) +If you come from older version, you might check the [Migration Guide](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/40-migration.md) ## Samples @@ -124,7 +124,7 @@ To your SBT `build.sbt` add the following lines: // enable Play cache API (based on your Play version) libraryDependencies += play.sbt.PlayImport.cacheApi // include play-redis library -libraryDependencies += "com.github.karelcemus" %% "play-redis" % "3.0.0-M1" +libraryDependencies += "com.github.karelcemus" %% "play-redis" % "3.0.0-M2" ``` @@ -132,7 +132,7 @@ libraryDependencies += "com.github.karelcemus" %% "play-redis" % "3.0.0-M1" | play framework | play-redis | documentation | |----------------|---------------------------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| 2.9.x | 3.0.0-M1 | [see here](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/README.md) | +| 2.9.x | 3.0.0-M2 | [see here](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/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)) | @@ -150,7 +150,7 @@ like this library, please feel free to report it or contact me. ## Changelog For the list of changes and migration guide please see -[the Changelog](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/CHANGELOG.md). +[the Changelog](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/CHANGELOG.md). ## Caveat diff --git a/doc/10-integration.md b/doc/10-integration.md index 5051aed..1e9d410 100644 --- a/doc/10-integration.md +++ b/doc/10-integration.md @@ -9,7 +9,7 @@ Although the use of runtime-time injection is preferred, both options are equal // enable Play cache API (based on your Play version) libraryDependencies += play.sbt.PlayImport.cacheApi // include play-redis library -libraryDependencies += "com.github.karelcemus" %% "play-redis" % "3.0.0-M1" +libraryDependencies += "com.github.karelcemus" %% "play-redis" % "3.0.0-M2" ``` diff --git a/doc/20-configuration.md b/doc/20-configuration.md index c288e98..0760efd 100644 --- a/doc/20-configuration.md +++ b/doc/20-configuration.md @@ -1,6 +1,6 @@ # Configuration -Default configuration and very detailed manual is available in [reference.conf](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/src/main/resources/reference.conf). It can be overwritten in your `conf/application.conf` file. +Default configuration and very detailed manual is available in [reference.conf](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/src/main/resources/reference.conf). It can be overwritten in your `conf/application.conf` file. There are several features supported in the configuration, they are discussed below. However, by default, there is no need for any further configuration. Default settings are set to the standalone instance running on `localhost:6379?db=0`, which is default for redis server. This instance is named `play` but is also exposed as a default implementation. diff --git a/doc/40-migration.md b/doc/40-migration.md index 3c66f90..78c0269 100644 --- a/doc/40-migration.md +++ b/doc/40-migration.md @@ -25,7 +25,7 @@ changes in public API, which needs your code to be updated. The invocation policy in `2.0.x` was used as an implicit parameter. Since `2.1.x` it is a static configurable property inside the instance configuration. -See the [updated documentation for more details](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#eager-and-lazy-invocation). +See the [updated documentation for more details](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/20-configuration.md#eager-and-lazy-invocation). ### Named caches uses @NamedCache instead of @Named @@ -39,7 +39,7 @@ Since `2.1.0`, there is a new `redis-timeout` property. To avoid ambiguity, the original `timeout` property was renamed to `sync-redis`. The `timeout` property was deprecated any will be removed in `2.2.0`. -See the updated [documentation for more details](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#eager-and-lazy-invocation). +See the updated [documentation for more details](https://github.com/KarelCemus/play-redis/blob/3.0.0-M2/doc/20-configuration.md#eager-and-lazy-invocation). ## Migration from 1.6.x to 2.0.x