Skip to content

Commit 97a7119

Browse files
authored
fix: update the readme to include the shadowed version (#159)
1 parent a3673a1 commit 97a7119

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ For the client-side integrations (web and mobile) have a look at the JavaScript,
3333
> The Stream chat Java SDK requires Java 11+. It supports latest LTS.
3434
3535
> The Stream chat Java SDK is compatible with Groovy, Scala, Kotlin and Clojure.
36+
3637
### Installation for Java
3738

3839
#### Gradle
@@ -42,6 +43,7 @@ dependencies {
4243
implementation "io.getstream:stream-chat-java:$stream_version"
4344
}
4445
```
46+
4547
#### Maven
4648

4749
```maven
@@ -99,30 +101,42 @@ dependencies {
99101
> You can see an example project at [GetStream/stream-chat-clojure-example](https://github.com/GetStream/stream-chat-clojure-example).
100102
101103
## 🔀 Dependencies
104+
102105
This SDK uses lombok (code generation), retrofit (http client), jackson (json) and jjwt (jwt).
103106

104107
> You can find the exact versions in [build.gradle](./build.gradle).
105108
109+
## 🥷🏿 Shadowed version
110+
111+
If you have conflicts with our dependencies, you can use the shadowed (shaded) version of the library:
112+
113+
<pre>
114+
io.getstream:stream-chat-java<b>-all</b>:1.26.2
115+
</pre>
116+
106117
## ✨ Getting started
118+
107119
### Configuration
108120

109121
To configure the SDK you need to provide required properties
110122

111-
| Property | ENV | Default | Required |
112-
| ------------- | ------------- | --- | --- |
113-
| io.getstream.chat.apiKey | STREAM_KEY | - | Yes |
114-
| io.getstream.chat.apiSecret | STREAM_SECRET | - | Yes |
115-
| io.getstream.chat.timeout | STREAM_CHAT_TIMEOUT | 10000 | No |
116-
| io.getstream.chat.url | STREAM_CHAT_URL | https://chat.stream-io-api.com | No |
123+
| Property | ENV | Default | Required |
124+
| --------------------------- | ------------------- | ------------------------------ | -------- |
125+
| io.getstream.chat.apiKey | STREAM_KEY | - | Yes |
126+
| io.getstream.chat.apiSecret | STREAM_SECRET | - | Yes |
127+
| io.getstream.chat.timeout | STREAM_CHAT_TIMEOUT | 10000 | No |
128+
| io.getstream.chat.url | STREAM_CHAT_URL | https://chat.stream-io-api.com | No |
117129

118130
You can also use your own CDN by creating an implementation of FileHandler and setting it this way
119131

120132
```java
121133
Message.fileHandlerClass = MyFileHandler.class
122134
```
135+
123136
All setup must be done prior to any request to the API.
124137

125138
## Print Chat app configuration
139+
126140
<table>
127141
<tbody>
128142
<tr><td><strong>Java</strong></td><td>
@@ -166,7 +180,7 @@ Head over to [DOCS.md](./DOCS.md) for code snippets.
166180

167181
1. If you get this exception: `java.lang.ClassNotFoundException: io.jsonwebtoken.SignatureAlgorithm`:
168182

169-
See issue [#16](https://github.com/GetStream/stream-chat-java/issues/16) for a work around. We only provide runtime only dependency for JWT per [recommendation](https://github.com/jwtk/jjwt#understanding-jjwt-dependencies). That's why it might be missing in your runtime and by addding implementation library into your deps, it should be gone.
183+
See [shadowed version](#-shadowed-version).
170184

171185
## ✍️ Contributing
172186

0 commit comments

Comments
 (0)