Skip to content

Commit d68895f

Browse files
dkasakpoljar
andauthored
Clarify project structure and status of internal crates (#5377)
Signed-off-by: Denis Kasak <[email protected]> Co-authored-by: Damir Jelić <[email protected]>
1 parent ab81388 commit d68895f

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ is designed to be flexible, async-friendly, and ready to use out of the box.
4848

4949
## Project structure
5050

51-
The Matrix Rust SDK is made up of several crates that build on top of each other. Here are the key ones:
51+
The Matrix Rust SDK is made up of several crates that build on top of each
52+
other. The following crates are expected to be usable as direct dependencies:
5253

5354
- [matrix-sdk-ui](https://docs.rs/matrix-sdk-ui/latest/matrix_sdk_ui/) – A high-level client library that makes it easy to build
5455
full-featured UI clients with minimal setup. Check out our reference client,
@@ -61,6 +62,9 @@ The Matrix Rust SDK is made up of several crates that build on top of each other
6162
See the [crypto tutorial](https://docs.rs/matrix-sdk-crypto/latest/matrix_sdk_crypto/tutorial/index.html)
6263
for a step-by-step introduction.
6364

65+
All other crates are effectively internal-only and only structured as crates
66+
for organizational purposes and to improve compilation times. Direct usage of them is discouraged.
67+
6468
## Status
6569

6670
The library is considered production ready and backs multiple client

0 commit comments

Comments
 (0)