diff --git a/docs/getting-started.md b/docs/getting-started.md index 0a9e29cc0..aa51264f3 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,9 +1,5 @@ **1. Add dependency** -``` python -import tensorflow as tf -``` - Maven ```xml @@ -28,54 +24,54 @@ libraryDependencies += "org.redisson" % "redisson" % "xVERSIONx" **2. Start development** -```java -// 1. Create config object -Config config = new Config(); -config.useClusterServers() - // use "rediss://" for SSL connection - .addNodeAddress("redis://127.0.0.1:7181"); - -// or read config from file -config = Config.fromYAML(new File("config-file.yaml")); -``` +1. Create config object + ```java + Config config = new Config(); + config.useClusterServers() + // use "rediss://" for SSL connection + .addNodeAddress("redis://127.0.0.1:7181"); -```java -// 2. Create Redisson instance + // or read config from file + config = Config.fromYAML(new File("config-file.yaml")); + ``` -// Sync and Async API -RedissonClient redisson = Redisson.create(config); +2. Create Redisson instance + ```java + // Sync and Async API + RedissonClient redisson = Redisson.create(config); -// Reactive API -RedissonReactiveClient redissonReactive = redisson.reactive(); + // Reactive API + RedissonReactiveClient redissonReactive = redisson.reactive(); -// RxJava3 API -RedissonRxClient redissonRx = redisson.rxJava(); -``` + // RxJava3 API + RedissonRxClient redissonRx = redisson.rxJava(); + ``` -```java -// 3. Get Redis or Valkey based implementation of java.util.concurrent.ConcurrentMap -RMap map = redisson.getMap("myMap"); +3. Get Redis or Valkey based object or service + ```java + // java.util.concurrent.ConcurrentMap -RMapReactive mapReactive = redissonReactive.getMap("myMap"); + RMap map = redisson.getMap("myMap"); -RMapRx mapRx = redissonRx.getMap("myMap"); -``` + RMapReactive mapReactive = redissonReactive.getMap("myMap"); -```java -// 4. Get Redis or Valkey based implementation of java.util.concurrent.locks.Lock -RLock lock = redisson.getLock("myLock"); + RMapRx mapRx = redissonRx.getMap("myMap"); -RLockReactive lockReactive = redissonReactive.getLock("myLock"); + // java.util.concurrent.locks.Lock -RLockRx lockRx = redissonRx.getLock("myLock"); -``` + RLock lock = redisson.getLock("myLock"); -```java -// 4. Get Redis or Valkey based implementation of java.util.concurrent.ExecutorService -RExecutorService executor = redisson.getExecutorService("myExecutorService"); + RLockReactive lockReactive = redissonReactive.getLock("myLock"); -// over 50 Redis or Valkey based Java objects and services ... + RLockRx lockRx = redissonRx.getLock("myLock"); -``` + // java.util.concurrent.ExecutorService + + RExecutorService executor = redisson.getExecutorService("myExecutorService"); + + // 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