Skip to content

Commit ddb9aa9

Browse files
committed
add Api stability notice
1 parent d550732 commit ddb9aa9

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,22 @@ It provides both Asynchronous REST and WebSocket clients, utilities for tick/lot
55

66
***
77

8+
## ⚠️ API Stability Notice
9+
10+
This SDK interacts with an exchange that is currently in beta.
11+
The API changes frequently and without prior notice, including modifications to fields, methods, and data structures.
12+
13+
Because of this:
14+
- Major versions will continue to change as long as fields or methods are added, removed, or modified.
15+
- Backward compatibility is not guaranteed between releases.
16+
- Some modules or endpoints may change or be removed at any time.
17+
- Always review the changelog before updating.
18+
19+
The SDK is actively maintained to keep up with upstream changes,
20+
but API instability should be expected while the exchange remains in beta.
21+
22+
***
23+
824
* [Documentation](SUMMARY.md)
925
* [Changelog](CHANGELOG.md)
1026

@@ -80,3 +96,9 @@ If WebSocket is enabled, you can subscribe to channels and receive live updates.
8096
* `bin` - examples for using all SDK methods
8197

8298
***
99+
100+
## 💡 Contributions are welcome!
101+
If you encounter outdated structures, missing fields, or other inconsistencies -
102+
feel free to open an issue or submit a pull request.
103+
104+
***

0 commit comments

Comments
 (0)