Update documentation regarding commons-redis deprecation

AVSystem · Dec 24, 2024 · 1fcc7dd · 1fcc7dd
1 parent b1a50d1
commit 1fcc7dd
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -33,7 +33,6 @@
     [`OptRef`](http://avsystem.github.io/scala-commons/api/com/avsystem/commons/misc/OptRef.html) (implemented as value
     classes)
   * [Components](docs/Components.md) and Dependency Injection library
-* `commons-redis` - [Scala driver for Redis](docs/RedisDriver.md)
 * `commons-macros` contains implementations of macros used in other modules and reusable macro utilities:
   * `MacroCommons` trait with several convenience functions for implementing macros
   * `TypeClassDerivation` - implements infrastructure for automatic type class derivation

diff --git a/docs/RedisDriver.md b/docs/RedisDriver.md
@@ -1,5 +1,8 @@
 # Redis driver
 
+**⚠️ WARNING: This module is deprecated and scheduled for removal in a future release. Please migrate to an alternative
+solution.**
+
 `commons-redis` - Scala driver for Redis
 
 ```scala