From 9c62908162210bfb2f0d19697f848ad11eb27423 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Thu, 9 Sep 2021 20:30:25 +0200 Subject: [PATCH] docs(base): Use the readme for the crate docs --- matrix_sdk_base/README.md | 23 +++++++++++------------ matrix_sdk_base/src/lib.rs | 15 ++------------- 2 files changed, 13 insertions(+), 25 deletions(-) diff --git a/matrix_sdk_base/README.md b/matrix_sdk_base/README.md index 9d6609ad..f266252d 100644 --- a/matrix_sdk_base/README.md +++ b/matrix_sdk_base/README.md @@ -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) -[![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) -[![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) +This crate implements the base to build a [Matrix](https://matrix.org/) client +library. -# 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 -probably interested in the main -[rust-sdk](https://github.com/matrix-org/matrix-rust-sdk/) crate. - -[Matrix]: https://matrix.org/ -[Rust]: https://www.rust-lang.org/ +* `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. diff --git a/matrix_sdk_base/src/lib.rs b/matrix_sdk_base/src/lib.rs index 0b3c9991..c5ef8128 100644 --- a/matrix_sdk_base/src/lib.rs +++ b/matrix_sdk_base/src/lib.rs @@ -13,18 +13,8 @@ // See the License for the specific language governing permissions and // limitations under the License. -//! This crate implements a [Matrix](https://matrix.org/) 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. -//! * `markdown`: Support for sending markdown formatted messages. +#![doc = include_str!("../README.md")] +#![cfg_attr(feature = "docs", feature(doc_cfg))] #![deny( missing_debug_implementations, missing_docs, @@ -34,7 +24,6 @@ unused_import_braces, unused_qualifications )] -#![cfg_attr(feature = "docs", feature(doc_cfg))] pub use matrix_sdk_common::*;