From 5637cdd1334e454c1f9d7201a1f1fa3b4de8911a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Tue, 26 May 2020 19:33:13 +0200 Subject: [PATCH] matrix-sdk: Add a bunch of readmes to the crates. --- README.md | 18 +++++++++++++++++- matrix_sdk/README.md | 16 ++++++++++++++++ matrix_sdk_base/README.md | 15 +++++++++++++++ matrix_sdk_common/README.md | 15 +++++++++++++++ matrix_sdk_crypto/README.md | 14 ++++++++++++++ matrix_sdk_test/README.md | 15 +++++++++++++++ matrix_sdk_test_macros/README.md | 15 +++++++++++++++ 7 files changed, 107 insertions(+), 1 deletion(-) create mode 100644 matrix_sdk/README.md create mode 100644 matrix_sdk_base/README.md create mode 100644 matrix_sdk_common/README.md create mode 100644 matrix_sdk_crypto/README.md create mode 100644 matrix_sdk_test/README.md create mode 100644 matrix_sdk_test_macros/README.md diff --git a/README.md b/README.md index 51986c22..2768c56f 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,25 @@ [Matrix]: https://matrix.org/ [Rust]: https://www.rust-lang.org/ +## 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 -This library is very much work in progress. +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 diff --git a/matrix_sdk/README.md b/matrix_sdk/README.md new file mode 100644 index 00000000..f7a0eac1 --- /dev/null +++ b/matrix_sdk/README.md @@ -0,0 +1,16 @@ +[![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) + +# matrix-sdk + +**matrix-sdk** is an implementation of a [Matrix][] client-server library in [Rust][]. + +[Matrix]: https://matrix.org/ +[Rust]: https://www.rust-lang.org/ + + +## License + +[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) diff --git a/matrix_sdk_base/README.md b/matrix_sdk_base/README.md new file mode 100644 index 00000000..9d6609ad --- /dev/null +++ b/matrix_sdk_base/README.md @@ -0,0 +1,15 @@ +[![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) + +# matrix-sdk-base + +**matrix-rust-sdk** is an implementation of a [Matrix][] client-server library in [Rust][]. + +**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/ diff --git a/matrix_sdk_common/README.md b/matrix_sdk_common/README.md new file mode 100644 index 00000000..fe21a84f --- /dev/null +++ b/matrix_sdk_common/README.md @@ -0,0 +1,15 @@ +[![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) + +# matrix-sdk-common + +**matrix-rust-sdk** is an implementation of a [Matrix][] client-server library in [Rust][]. + +**NOTE:** These are common dependencies for the different sdk layers, +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/ diff --git a/matrix_sdk_crypto/README.md b/matrix_sdk_crypto/README.md new file mode 100644 index 00000000..d44f4f6d --- /dev/null +++ b/matrix_sdk_crypto/README.md @@ -0,0 +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) + +# matrix-sdk-crypto + +**matrix-rust-sdk** is an implementation of a [Matrix][] client-server library in [Rust][]. + +**NOTE:** This is a E2EE implementation for Matrix, you are 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/ diff --git a/matrix_sdk_test/README.md b/matrix_sdk_test/README.md new file mode 100644 index 00000000..2c0f48f4 --- /dev/null +++ b/matrix_sdk_test/README.md @@ -0,0 +1,15 @@ +[![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) + +# matrix-sdk-test + +**matrix-rust-sdk** is an implementation of a [Matrix][] client-server library in [Rust][]. + +**NOTE:** These are just test helpers for the matrix-rust-sdk, 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/ diff --git a/matrix_sdk_test_macros/README.md b/matrix_sdk_test_macros/README.md new file mode 100644 index 00000000..7a467b1e --- /dev/null +++ b/matrix_sdk_test_macros/README.md @@ -0,0 +1,15 @@ +[![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) + +# matrix-sdk-test-macros + +**matrix-rust-sdk** is an implementation of a [Matrix][] client-server library in [Rust][]. + +**NOTE:** These are just macros that help test the matrix-rust-sdk, 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/