From d68895f24a4e9685fabb7e626df30cd7dd8a440f Mon Sep 17 00:00:00 2001 From: Denis Kasak Date: Wed, 9 Jul 2025 16:47:38 +0200 Subject: [PATCH] Clarify project structure and status of internal crates (#5377) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Denis Kasak Co-authored-by: Damir Jelić --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 62b932578..557bed98f 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,8 @@ is designed to be flexible, async-friendly, and ready to use out of the box. ## Project structure -The Matrix Rust SDK is made up of several crates that build on top of each other. Here are the key ones: +The Matrix Rust SDK is made up of several crates that build on top of each +other. The following crates are expected to be usable as direct dependencies: - [matrix-sdk-ui](https://docs.rs/matrix-sdk-ui/latest/matrix_sdk_ui/) – A high-level client library that makes it easy to build 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 See the [crypto tutorial](https://docs.rs/matrix-sdk-crypto/latest/matrix_sdk_crypto/tutorial/index.html) for a step-by-step introduction. +All other crates are effectively internal-only and only structured as crates +for organizational purposes and to improve compilation times. Direct usage of them is discouraged. + ## Status The library is considered production ready and backs multiple client