From 22b8f0a7ce49147160f1f5be747b54d227437d84 Mon Sep 17 00:00:00 2001 From: Ruben Gees Date: Tue, 16 Jan 2024 18:07:30 +0100 Subject: [PATCH] Update README --- README.md | 17 +++-------------- 1 file changed, 3 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 566eae6..c04fd84 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,9 @@ dependencies { } ``` -This library comes with a default implementation for both jedis and lettuce. +This library comes with a default implementation +for [Jedis](https://github.com/redis/jedis),[Lettuce](https://lettuce.io/) +and [Spring Data Redis](https://spring.io/projects/spring-data-redis/). ### Emit Cheatsheet @@ -81,19 +83,6 @@ The [example](example) directory contains a working docker-compose setup which c using `docker-compose --compatibility up`. The setup contains one redis instance, one java publisher, three socket.io-servers and three consuming socket.io-clients. -### Usage in Spring Boot and Jedis - -We don't want to rely on the Spring Data Redis abstractions in this project. -Unfortunately, this makes it necessary that you configure the `JedisPool` manually in your Spring Boot application. -Having JedisPool configured, the emitter can be created as follows: - -```kotlin -@Bean -fun emitter(jedisPool: JedisPool): Emitter { - return Emitter(JedisPublisher(jedisPool)) -} -``` - ## :warning: Limitations - The room and namespaces have not been tested yet.