Fork of github.com/matrix-org/matrix-rust-sdk
 
 
Go to file
Devin R 71f2a042c2 Rename Stub -> Sync for all ruma events 2020-07-18 08:37:43 -04:00
matrix_sdk Rename Stub -> Sync for all ruma events 2020-07-18 08:37:43 -04:00
matrix_sdk_base Rename Stub -> Sync for all ruma events 2020-07-18 08:37:43 -04:00
matrix_sdk_common Rename Stub -> Sync for all ruma events 2020-07-18 08:37:43 -04:00
matrix_sdk_common_macros matrix-sdk: Bump our dependencies. 2020-07-17 10:01:22 +02:00
matrix_sdk_crypto Rename Stub -> Sync for all ruma events 2020-07-18 08:37:43 -04:00
matrix_sdk_test Rename Stub -> Sync for all ruma events 2020-07-18 08:37:43 -04:00
matrix_sdk_test_macros matrix-sdk: Add a bunch of readmes to the crates. 2020-05-26 19:33:13 +02:00
.gitignore Fix the gitignore file. 2019-11-24 22:44:28 +01:00
.pre-commit-config.yaml Rename Stub -> Sync for all ruma events 2020-07-18 08:37:43 -04:00
.travis.yml travis: Don't allow failures for Windows. 2020-07-16 14:23:36 +02:00
Cargo.toml matrix-sdk: Remove the wrongly committed olm-sys/olm-rs patch defintions. 2020-07-11 22:18: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

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