Fork of github.com/matrix-org/matrix-rust-sdk
 
 
Go to file
Damir Jelić 0c5d13cb91 crypto: Remove some stale TODO comments 2021-03-10 10:03:54 +01:00
.github/workflows CI: Publish docs via github pages 2021-03-01 12:53:35 +01:00
contrib/mitmproxy contrib: Make the failures mitmproxy script a bit smarter. 2021-03-02 12:24:23 +01:00
matrix_sdk matrix-sdk-base: remove InvitedRoom, JoinedRoom, LeftRoom and RoomState 2021-03-05 12:19:50 +01:00
matrix_sdk_base Merge branch 'room_merge' 2021-03-08 13:39:46 +01:00
matrix_sdk_common matrix-sdk: Bump Ruma 2021-03-01 19:20:07 +01:00
matrix_sdk_crypto crypto: Remove some stale TODO comments 2021-03-10 10:03:54 +01:00
matrix_sdk_test
matrix_sdk_test_macros
.gitignore
.pre-commit-config.yaml
Cargo.toml
LICENSE
Makefile
README.md README: Add a badge that points to the latest master docs 2021-03-02 11:40:02 +01:00
tarpaulin.toml

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