Skip to content

Commit 1f11609

Browse files
committed
docs: make the deprecation notice prominent and mark the SDK as legacy
1 parent 975dde3 commit 1f11609

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
1-
> [!WARNING]
2-
> **`stream-chat-java` is deprecated.** New projects should use [`stream-sdk-java`](https://github.com/GetStream/stream-sdk-java) (Maven `io.getstream:stream-sdk-java`), which covers Chat, Video, Moderation and Feeds. To move existing code, see the [migration guide](https://github.com/GetStream/stream-sdk-java/tree/main/docs/migration-from-stream-chat-java).
1+
> [!CAUTION]
2+
> ## ⚠️ This is a legacy SDK. It is deprecated.
3+
>
4+
> 🚫 **Do not start new projects with `stream-chat-java`.**
5+
>
6+
> ✅ **Use [`stream-sdk-java`](https://github.com/GetStream/stream-sdk-java) (Maven `io.getstream:stream-sdk-java`) instead.** It covers Chat, Video, Moderation and Feeds in one SDK.
7+
>
8+
> 🔁 **Already using `stream-chat-java`?** Follow the [migration guide](https://github.com/GetStream/stream-sdk-java/tree/main/docs/migration-from-stream-chat-java) to move your code.
39
4-
# Official Java SDK for [Stream Chat](https://getstream.io/chat/docs/)
10+
# Legacy Java SDK for [Stream Chat](https://getstream.io/chat/docs/)
511

612
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.getstream/stream-chat-java/badge.svg?style=flat)](https://maven-badges.herokuapp.com/maven-central/io.getstream/stream-chat-java) [![build](https://github.com/GetStream/stream-chat-java/workflows/Build/badge.svg)](https://github.com/GetStream/stream-chat-java/actions)
713

814
<p align="center">
9-
<img src="./assets/logo.svg" width="50%" height="50%">
10-
</p>
11-
<p align="center">
12-
Official Java API client for Stream Chat, a service for building chat applications.
15+
Legacy Java API client for Stream Chat, a service for building chat applications.
1316
<br />
1417
<a href="https://getstream.io/chat/docs/"><strong>Explore the docs »</strong></a>
1518
<br />

0 commit comments

Comments
 (0)