Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rubengees committed Jan 17, 2024
1 parent e4567f9 commit 8ab7a7e
Showing 1 changed file with 3 additions and 14 deletions.
17 changes: 3 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.

0 comments on commit 8ab7a7e

Please sign in to comment.