From 7ff2deccee6123e8e1bd88f02910b0be99f5405d Mon Sep 17 00:00:00 2001 From: mrniko <1104661+mrniko@users.noreply.github.com> Date: Sun, 9 Mar 2025 16:23:15 +0300 Subject: [PATCH] docs updated --- docs/README.md | 2 +- docs/client-side-caching.md | 2 +- docs/getting-started.md | 53 ++++++++++++++++++++----------------- 3 files changed, 30 insertions(+), 27 deletions(-) diff --git a/docs/README.md b/docs/README.md index 435087ce9..b59f315d4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# Redisson - Valkey & Redis Java client
Complete Real-Time Data Platform +# Redisson - Valkey & Redis Java client
Real-Time Data Platform High-performance async and lock-free Java client for Redis and Valkey based on [Netty](http://netty.io) framework. diff --git a/docs/client-side-caching.md b/docs/client-side-caching.md index a1b17063b..99451f0b0 100644 --- a/docs/client-side-caching.md +++ b/docs/client-side-caching.md @@ -1,4 +1,4 @@ -##Native implementation +## Native implementation Client Side caching is implemented using client tracking listener through `RESP3` protocol available in Redis or Valkey. diff --git a/docs/getting-started.md b/docs/getting-started.md index 0cd813ed8..a25c274a1 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,26 +1,31 @@ **1. Add dependency** - -Maven - -```xml - - org.redisson - redisson - xVERSIONx - -``` - -Gradle - -```java -compile 'org.redisson:redisson:xVERSIONx' -``` - -SBT - -```java -libraryDependencies += "org.redisson" % "redisson" % "xVERSIONx" -``` +
+
+

Redisson PRO

+
Maven
+
<dependency>
+   <groupId>pro.redisson</groupId>
+   <artifactId>redisson</artifactId>
+   <version>xVERSIONx</version>
+</dependency>
+
Gradle
+
compile 'pro.redisson:redisson:xVERSIONx'
+
+ +
+

Community Edition

+
Maven
+
<dependency>
+   <groupId>org.redisson</groupId>
+   <artifactId>redisson</artifactId>
+   <version>xVERSIONx</version>
+</dependency>
+
Gradle
+
compile 'org.redisson:redisson:xVERSIONx'
+
+
+ +[Redisson PRO vs. Community Edition ➜](https://redisson.pro/feature-comparison.html) **2. Start development** @@ -89,6 +94,4 @@ Use one of supported modes: ([single mode](configuration.md/#single-mode), // over 50 Redis or Valkey based Java objects and services ... ``` -More code examples can be found [here](https://github.com/redisson/redisson-examples). - -Upgrade to __[Redisson PRO](https://redisson.pro)__ with **advanced features**. \ No newline at end of file +More code examples can be found [here](https://github.com/redisson/redisson-examples). \ No newline at end of file