docs(common): Use the readme for the crate level docs
This commit is contained in:
parent
48b3307934
commit
92b0ba21e4
3 changed files with 15 additions and 10 deletions
|
@ -1,15 +1,9 @@
|
|||
[](https://travis-ci.org/matrix-org/matrix-rust-sdk)
|
||||
[](https://codecov.io/gh/matrix-org/matrix-rust-sdk)
|
||||
[](https://opensource.org/licenses/Apache-2.0)
|
||||
[](https://matrix.to/#/#matrix-rust-sdk:matrix.org)
|
||||
Common types that are used in the different [matrix-sdk] layers.
|
||||
|
||||
# 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,
|
||||
**NOTE:** These are common dependencies for the different [matrix-sdk] layers,
|
||||
you're probably interested in the main
|
||||
[rust-sdk](https://github.com/matrix-org/matrix-rust-sdk/) crate.
|
||||
[matrix-sdk](https://docs.rs/matrix-sdk/) crate.
|
||||
|
||||
[matrix-sdk]: https://github.com/matrix-org/matrix-rust-sdk/
|
||||
[Matrix]: https://matrix.org/
|
||||
[Rust]: https://www.rust-lang.org/
|
||||
|
|
|
@ -133,6 +133,7 @@ impl SyncResponse {
|
|||
}
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug)]
|
||||
pub struct RoomEvent {
|
||||
/// The actual event.
|
||||
pub event: Raw<ruma::events::AnyRoomEvent>,
|
||||
|
|
|
@ -1,3 +1,13 @@
|
|||
#![doc = include_str!("../README.md")]
|
||||
#![deny(
|
||||
missing_debug_implementations,
|
||||
trivial_casts,
|
||||
trivial_numeric_casts,
|
||||
unused_extern_crates,
|
||||
unused_import_braces,
|
||||
unused_qualifications
|
||||
)]
|
||||
|
||||
pub use async_trait::async_trait;
|
||||
pub use instant;
|
||||
pub use uuid;
|
||||
|
|
Loading…
Reference in a new issue