matrix-rust-sdk/matrix_sdk_base
Damir Jelić 9c62908162 docs(base): Use the readme for the crate docs 2021-09-09 20:57:58 +02:00
..
.cargo matrix-sdk: Add missing newlines at the end of some files. 2020-05-12 15:48:17 +02:00
examples Simplify ruma identifier imports 2021-06-23 16:12:23 +02:00
src docs(base): Use the readme for the crate docs 2021-09-09 20:57:58 +02:00
Cargo.toml fix(sdk): Use the markdown feature flag of ruma dirrectly 2021-09-09 20:57:58 +02:00
README.md docs(base): Use the readme for the crate docs 2021-09-09 20:57:58 +02:00

README.md

This crate implements the base to build a Matrix client library.

Crate Feature Flags

The following crate feature flags are available:

  • encryption: Enables end-to-end encryption support in the library.
  • sled_cryptostore: Enables a Sled based store for the encryption keys. If this is disabled and encryption support is enabled the keys will by default be stored only in memory and thus lost after the client is destroyed.
  • sled_state_store: Enables a Sled based store for the storage of the local client state.