docs: README.md.

LegacyLands · Dec 23, 2024 · a0ce642 · a0ce642
1 parent 14e6be3
commit a0ce642
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/cache/README.md b/cache/README.md
@@ -10,7 +10,7 @@ The original purpose of this module was to design a L1 cache for the `mongodb` m
 ```kotlin
 // Dependencies
 dependencies {
-    // annotation module
+    // cache module
     compileOnly("me.qwqdev.library:cache:1.0-SNAPSHOT")
 }
 ```
@@ -58,6 +58,18 @@ public class CacheLauncher {
                 true
         );
 
+        // for redisCacheService, it is recommended to use redissonClient to acquire the lock
+        redisCache.execute(
+                // get lock
+                redissonClient -> redissonClient.getLock("a"),
+
+                // do something
+                redissonClient -> redissonClient.getBucket("a").get(),
+
+                // lock settings
+                LockSettings.of(1, 1, TimeUnit.MINUTES)
+        );
+
 
         /*
          * Caffeine cache example
@@ -107,7 +119,7 @@ public class CacheLauncher {
                 LockSettings.of(1, 1, TimeUnit.MINUTES)
         );
 
-        // thread-safe execution of something, redis cache same
+        // thread-safe execution of something
         caffeineCache.execute(
                 // get lock
                 cache -> new ReentrantLock(),

diff --git a/mongodb/README.md b/mongodb/README.md
@@ -13,7 +13,7 @@ For the first and second level cache, it is actually implemented in the cache mo
 ```kotlin
 // Dependencies
 dependencies {
-    // annotation module
+    // mongodb module
     compileOnly("me.qwqdev.library:mongodb:1.0-SNAPSHOT")
 }
 ```