Fork of github.com/matrix-org/matrix-rust-sdk

Go to file

Damir Jelić abe40dff11 matrix_sdk: Remove code duplication in our send methods.		2020-06-09 16:28:54 +02:00
matrix_sdk	matrix_sdk: Remove code duplication in our send methods.	2020-06-09 16:28:54 +02:00
matrix_sdk_base	Merge branch 'unify-ee-methods'	2020-06-02 10:30:20 +02:00
matrix_sdk_common	common: Depend on the git version of futures-locks again.	2020-05-26 22:21:03 +02:00
matrix_sdk_crypto	crypto: Remove some unnecessary mem::replace calls.	2020-06-02 10:36:51 +02:00
matrix_sdk_test	test: Add a copy of the test data to the test crate.	2020-05-26 21:30:15 +02:00
matrix_sdk_test_macros	matrix-sdk: Add a bunch of readmes to the crates.	2020-05-26 19:33:13 +02:00
test_data	async_client: add docs/test for register_user, send_uiaa and RegistrationBuilder	2020-06-02 17:13:29 -04:00
.gitignore	Fix the gitignore file.	2019-11-24 22:44:28 +01:00
.pre-commit-config.yaml	nio-rust: Add a pre-commit config.	2019-11-10 18:33:27 +01:00
.travis.yml	travis: fail-fast for wasm target	2020-05-13 14:48:46 +02:00
Cargo.toml	matrix-sdk: Switch to upstream crates	2020-05-12 17:32:01 +02:00
LICENSE	rust-sdk: Switch the license to Apache 2.0.	2020-02-21 16:54:05 +01:00
Makefile	matrix-sdk: Split out the crypto part of the sdk into a separate crate.	2020-04-29 09:48:00 +02:00
README.md	matrix-sdk: Add a bunch of readmes to the crates.	2020-05-26 19:33:13 +02:00
design.md	state_store: clean up and add examples to docs	2020-04-26 17:13:55 -04:00

matrix-rust-sdk

matrix-rust-sdk is an implementation of a Matrix client-server library in Rust.

Project structure

The rust-sdk consists of multiple crates that can be picked at your convenience:

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.

The library is in an alpha state, things that are implemented generally work but the API will change in breaking ways.

If you are interested in using the matrix-sdk now is the time to try it out and provide feedback.