2020-03-15 12:02:20 +00:00
|
|
|
[](https://travis-ci.org/matrix-org/matrix-rust-sdk)
|
2020-04-03 12:20:12 +00:00
|
|
|
[](https://codecov.io/gh/matrix-org/matrix-rust-sdk)
|
|
|
|
|
[](https://opensource.org/licenses/Apache-2.0)
|
2020-04-11 19:01:29 +00:00
|
|
|
[](https://matrix.to/#/#matrix-rust-sdk:matrix.org)
|
2020-03-15 12:02:20 +00:00
|
|
|
|
2020-02-21 15:57:18 +00:00
|
|
|
# matrix-rust-sdk
|
2019-10-20 11:56:46 +00:00
|
|
|
|
2020-02-21 15:57:18 +00:00
|
|
|
**matrix-rust-sdk** is an implementation of a [Matrix][] client-server library in [Rust][].
|
2019-10-20 11:56:46 +00:00
|
|
|
|
|
|
|
|
[Matrix]: https://matrix.org/
|
|
|
|
|
[Rust]: https://www.rust-lang.org/
|
|
|
|
|
|
2020-05-26 17:33:13 +00:00
|
|
|
## 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.
|
|
|
|
|
|
2019-10-20 11:56:46 +00:00
|
|
|
## Status
|
|
|
|
|
|
2020-05-26 17:33:13 +00:00
|
|
|
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.
|
2019-10-20 11:56:46 +00:00
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
2020-04-03 12:51:51 +00:00
|
|
|
[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)
|
