Merge branch 'main' into rav/history_sharing/upload_bundle

Author: richvdh

README.md

@@ -1,40 +1,68 @@
-![Build Status](https://img.shields.io/github/actions/workflow/status/matrix-org/matrix-rust-sdk/ci.yml?style=flat-square)
-[![codecov](https://img.shields.io/codecov/c/github/matrix-org/matrix-rust-sdk/main.svg?style=flat-square)](https://codecov.io/gh/matrix-org/matrix-rust-sdk)
-[![License](https://img.shields.io/badge/License-Apache%202.0-yellowgreen.svg?style=flat-square)](https://opensource.org/licenses/Apache-2.0)
-[![#matrix-rust-sdk](https://img.shields.io/badge/matrix-%23matrix--rust--sdk-blue?style=flat-square)](https://matrix.to/#/#matrix-rust-sdk:matrix.org)
-[![Docs - Main](https://img.shields.io/badge/docs-main-blue.svg?style=flat-square)](https://matrix-org.github.io/matrix-rust-sdk/matrix_sdk/)
-[![Docs - Stable](https://img.shields.io/crates/v/matrix-sdk?color=blue&label=docs&style=flat-square)](https://docs.rs/matrix-sdk)
+<h1 align="center">Matrix Rust SDK</h1>
+<div align="center">
+    <i>Your all-in-one toolkit for creating Matrix clients with Rust, from simple bots to full-featured apps.</i>
+    <br/><br/>
+    <img src="contrib/logo.svg">
+    <br>
+    <hr>
+    <a href="https://github.com/matrix-org/matrix-rust-sdk/releases">
+        <img src="https://img.shields.io/github/v/release/matrix-org/matrix-rust-sdk?style=flat&labelColor=1C2E27&color=66845F&logo=GitHub&logoColor=white"></a>
+    <a href="https://crates.io/crates/matrix-sdk/">
+        <img src="https://img.shields.io/crates/v/matrix-sdk?style=flat&labelColor=1C2E27&color=66845F&logo=Rust&logoColor=white"></a>
+    <a href="https://codecov.io/gh/matrix-org/matrix-rust-sdk">
+        <img src="https://img.shields.io/codecov/c/gh/matrix-org/matrix-rust-sdk?style=flat&labelColor=1C2E27&color=66845F&logo=Codecov&logoColor=white"></a>
+    <br>
+    <a href="https://docs.rs/matrix-sdk/">
+        <img src="https://img.shields.io/docsrs/matrix-sdk?style=flat&labelColor=1C2E27&color=66845F&logo=Rust&logoColor=white"></a>
+    <a href="https://github.com/matrix-org/matrix-rust-sdk/actions/workflows/ci.yml">
+        <img src="https://img.shields.io/github/actions/workflow/status/matrix-org/matrix-rust-sdk/ci.yml?style=flat&labelColor=1C2E27&color=66845F&logo=GitHub%20Actions&logoColor=white"></a>
+    <br>
+    <br>
+</div>
 
-# matrix-rust-sdk
 
-**matrix-rust-sdk** is an implementation of a [Matrix][] client-server library in [Rust][].
+The Matrix Rust SDK is a collection of libraries that make it easier to build
+[Matrix] clients in [Rust]. It takes care of the low-level details like encryption,
+syncing, and room state, so you can focus on your app's logic and UI. Whether
+you're writing a small bot, a desktop client, or something in between, the SDK
+is designed to be flexible, async-friendly, and ready to use out of the box.
 
 [Matrix]: https://matrix.org/
 [Rust]: https://www.rust-lang.org/
 
 ## Project structure
 
-The rust-sdk consists of multiple crates that can be picked at your convenience:
+The Matrix Rust SDK is made up of several crates that build on top of each other. Here are the key ones:
 
-- **matrix-sdk** - High level client library, with batteries included, you're most likely
-  interested in this.
-- **matrix-sdk-base** - No (network) IO client state machine that can be used to embed a
-  Matrix client in your project or build a full fledged network enabled client
-  lib on top of it.
-- **matrix-sdk-crypto** - No (network) IO encryption state machine that can be
-  used to add Matrix E2EE support to your client or client library.
+- [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,
+  [multiverse](https://github.com/matrix-org/matrix-rust-sdk/tree/main/labs/multiverse), for an example.
+- [matrix-sdk](https://docs.rs/matrix-sdk/latest/matrix_sdk/) – A mid-level client library, ideal for building bots, custom
+  clients, or higher-level abstractions. You can find example usage in the
+  [examples directory](https://github.com/matrix-org/matrix-rust-sdk/tree/main/examples).
+- [matrix-sdk-crypto](https://docs.rs/matrix-sdk-crypto/latest/matrix_sdk_crypto/) – A standalone encryption state machine with no network I/O,
+  providing end-to-end encryption support for Matrix clients and libraries.
+  See the [crypto tutorial](https://docs.rs/matrix-sdk-crypto/latest/matrix_sdk_crypto/tutorial/index.html)
+  for a step-by-step introduction.
 
 ## Status
 
-The library is considered production ready and backs multiple client implementations such as Element X [[1]](https://github.com/element-hq/element-x-ios) [[2]](https://github.com/element-hq/element-x-android) and [Fractal](https://gitlab.gnome.org/World/fractal). Client developers should feel confident to build upon it.
+The library is considered production ready and backs multiple client
+implementations such as Element X
+[[1]](https://github.com/element-hq/element-x-ios)
+[[2]](https://github.com/element-hq/element-x-android),
+[Fractal](https://gitlab.gnome.org/World/fractal) and [iamb](https://github.com/ulyssa/iamb). Client developers should feel
+confident to build upon it.
 
-Development of the SDK has been primarily sponsored by Element though accepts contributions from all.
+Development of the SDK has been primarily sponsored by Element though accepts
+contributions from all.
 
 ## Bindings
 
-Some crates of the **matrix-rust-sdk** can be embedded inside other
-environments, like Swift, Kotlin, JavaScript, Node.js etc. Please,
-explore the [`bindings/`](./bindings/) directory to learn more.
+The higher-level crates of the Matrix Rust SDK can be embedded in other
+environments such as Swift, Kotlin, JavaScript, and Node.js. Check out the
+[bindings/](./bindings/) directory to learn more about how to integrate the SDK
+into your language of choice.
 
 ## License
 

bindings/matrix-sdk-ffi/CHANGELOG.md

@@ -1,4 +1,10 @@
-# unreleased
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+<!-- next-header -->
+
+## [Unreleased] - ReleaseDate
 
 Breaking changes:
 

bindings/matrix-sdk-ffi/Cargo.toml

@@ -8,6 +8,7 @@ license = "Apache-2.0"
 readme = "README.md"
 rust-version = { workspace = true }
 repository = "https://github.com/matrix-org/matrix-rust-sdk"
+publish = false
 
 [lib]
 crate-type = ["cdylib", "staticlib"]
@@ -23,7 +24,7 @@ vergen = { version = "8.1.3", features = ["build", "git", "gitcl"] }
 [dependencies]
 anyhow = { workspace = true }
 as_variant = { workspace = true }
-async-compat = "0.2.5"
+async-compat = "0.2.4"
 eyeball-im = { workspace = true }
 extension-trait = "1.0.1"
 futures-util = { workspace = true }
@@ -80,4 +81,4 @@ features = [
 workspace = true
 
 [package.metadata.release]
-release = false
+release = true