Fork of github.com/matrix-org/matrix-rust-sdk
 
 
Go to file
Damir Jelić af74988a83 chore: Rename the crate folders to use dashes instead of underscores 2021-09-14 16:38:33 +02:00
.cargo Use rustdoc-map to link to external crates in master docs 2021-07-02 18:05:34 +02:00
.github/workflows chore: Rename the crate folders to use dashes instead of underscores 2021-09-14 16:38:33 +02:00
contrib/mitmproxy contrib: Make the failures mitmproxy script a bit smarter. 2021-03-02 12:24:23 +01:00
crates chore: Rename the crate folders to use dashes instead of underscores 2021-09-14 16:38:33 +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
.rustfmt.toml Add cargo fmt to ci using nightly 2021-05-12 15:38:59 -04:00
Cargo.toml chore: Rename the crate folders to use dashes instead of underscores 2021-09-14 16:38:33 +02:00
LICENSE rust-sdk: Switch the license to Apache 2.0. 2020-02-21 16:54:05 +01:00
README.md README: Add a badge that points to the latest master docs 2021-03-02 11:40:02 +01:00
tarpaulin.toml tarpaulin: Disable tarpaulin debugging. 2020-08-11 10:55:10 +02:00

README.md

Build Status codecov License #matrix-rust-sdk Docs - Master Docs - Stable

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