Fork of github.com/matrix-org/matrix-rust-sdk
 
 
Go to file
Damir Jelić c6a80dc921 Merge branch 'master' into new-state-store 2021-01-04 17:34:33 +01:00
.github/workflows CI: Restrict code coverage to the master branch. 2020-12-08 14:30:49 +01:00
matrix_sdk Merge branch 'master' into new-state-store 2021-01-04 17:34:33 +01:00
matrix_sdk_base Merge branch 'master' into new-state-store 2021-01-04 17:34:33 +01:00
matrix_sdk_common matrix-sdk: Bump our deps. 2021-01-04 17:22:09 +01:00
matrix_sdk_crypto Merge branch 'master' into new-state-store 2021-01-04 17:34:33 +01:00
matrix_sdk_test Merge branch 'master' into new-state-store 2021-01-04 17:34:33 +01:00
matrix_sdk_test_macros matrix-sdk: Add a bunch of readmes to the crates. 2020-05-26 19:33:13 +02:00
.gitignore matrix_sdk_crypto: Fix clippy warnings add wasm emscripten to .gitignore 2020-08-04 20:02:09 -04:00
.pre-commit-config.yaml nio-rust: Add a pre-commit config. 2019-11-10 18:33:27 +01:00
.travis.yml Fix travis ci errors 2020-08-21 19:11:10 +02:00
Cargo.toml matrix-sdk: Get rid of the common macros crate 2021-01-04 16:34:14 +01: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 README: Swap out the CI badge. 2020-12-08 14:31:14 +01:00
design.md state_store: clean up and add examples to docs 2020-04-26 17:13:55 -04:00
tarpaulin.toml tarpaulin: Disable tarpaulin debugging. 2020-08-11 10:55:10 +02:00

README.md

Build Status codecov License #matrix-rust-sdk

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.

Status

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.

License

Apache-2.0