char/matrix-rust-sdk
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs(base): Use the readme for the crate docs

Browse source
This commit is contained in:
Damir Jelić 2021-09-09 20:30:25 +02:00
parent 913cb39d28
commit 9c62908162
2 changed files with 13 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
matrix_sdk_base/README.md
View file

@ -1,15 +1,14 @@
[![Build Status](https://img.shields.io/travis/matrix-org/matrix-rust-sdk.svg?style=flat-square)](https://travis-ci.org/matrix-org/matrix-rust-sdk) This crate implements the base to build a [Matrix](https://matrix.org/) client
[![codecov](https://img.shields.io/codecov/c/github/matrix-org/matrix-rust-sdk/master.svg?style=flat-square)](https://codecov.io/gh/matrix-org/matrix-rust-sdk) library.
[![License](https://img.shields.io/badge/License-Apache%202.0-yellowgreen.svg?style=flat-square)](https://opensource.org/licenses/Apache-2.0)
[![#matrix-rust-sdk](https://img.shields.io/badge/matrix-%23matrix--rust--sdk-blue?style=flat-square)](https://matrix.to/#/#matrix-rust-sdk:matrix.org)
# matrix-sdk-base ## Crate Feature Flags
**matrix-rust-sdk** is an implementation of a [Matrix][] client-server library in [Rust][]. The following crate feature flags are available:
**NOTE:** This is the no IO client state machine, you're * `encryption`: Enables end-to-end encryption support in the library.
probably interested in the main * `sled_cryptostore`: Enables a Sled based store for the encryption
[rust-sdk](https://github.com/matrix-org/matrix-rust-sdk/) crate. 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
[Matrix]: https://matrix.org/ destroyed.
[Rust]: https://www.rust-lang.org/ * `sled_state_store`: Enables a Sled based store for the storage of the local
client state.

15
matrix_sdk_base/src/lib.rs
View file

@ -13,18 +13,8 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
//! This crate implements a [Matrix](https://matrix.org/) client library. #![doc = include_str!("../README.md")]
//! #![cfg_attr(feature = "docs", feature(doc_cfg))]
//! ## 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.
//! * `markdown`: Support for sending markdown formatted messages.
#![deny( #![deny(
missing_debug_implementations, missing_debug_implementations,
missing_docs, missing_docs,
@ -34,7 +24,6 @@
unused_import_braces, unused_import_braces,
unused_qualifications unused_qualifications
)] )]
#![cfg_attr(feature = "docs", feature(doc_cfg))]
pub use matrix_sdk_common::*; pub use matrix_sdk_common::*;