diff --git a/README.md b/README.md index 36a8d1e1..4c63c619 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,21 @@ # Ruma – Your home in Matrix. -*Monorepo for our various Rust + Matrix crates.* +A set of [Rust] crates (libraries) for interacting with the [Matrix] chat network. [website] • [chat] -[website]: https://www.ruma.io +[Rust]: https://rust-lang.org/ +[Matrix]: https://matrix.org/ +[website]: https://www.ruma.io/ [chat]: https://matrix.to/#/#ruma:matrix.org +## Status + +As of 2020-09-29, we support the vast majority of endpoints in all of the various Matrix APIs. + +As long as they are still at version 0.x though, only the latest API revision is considered +supported. This may change after 1.x releases. + ## Contributing See [CONTRIBUTING.md](CONTRIBUTING.md). diff --git a/ruma-api-macros/README.md b/ruma-api-macros/README.md index 0aba52b0..2c6d63a7 100644 --- a/ruma-api-macros/README.md +++ b/ruma-api-macros/README.md @@ -57,9 +57,3 @@ pub mod some_endpoint { } } ``` - -## Documentation - -Please refer to the documentation of the `ruma_api!` re-export in [ruma-api][]. - -[ruma-api]: https://docs.rs/ruma-api diff --git a/ruma-api/README.md b/ruma-api/README.md index ff32448a..e47f995f 100644 --- a/ruma-api/README.md +++ b/ruma-api/README.md @@ -6,7 +6,3 @@ **ruma-api** contains core types used to define the requests and responses for each endpoint in the various [Matrix](https://matrix.org/) API specifications. These types can be shared by client and server code for all Matrix APIs. - -## Documentation - -ruma-api has [comprehensive documentation](https://docs.rs/ruma-api) available on docs.rs. diff --git a/ruma-appservice-api/README.md b/ruma-appservice-api/README.md index 590c2441..deeecd7c 100644 --- a/ruma-appservice-api/README.md +++ b/ruma-appservice-api/README.md @@ -1,5 +1,9 @@ # ruma-appservice-api +[![crates.io page](https://img.shields.io/crates/v/ruma-appservice-api.svg)](https://crates.io/crates/ruma-appservice-api) +[![docs.rs page](https://docs.rs/ruma-appservice-api/badge.svg)](https://docs.rs/ruma-appservice-api/) +![license: MIT](https://img.shields.io/crates/l/ruma-appservice-api.svg) + **ruma-appservice-api** contains serializable types for the requests and responses for each endpoint in the [Matrix](https://matrix.org/) application service API specification. These types can be shared by application service and server code. diff --git a/ruma-client/README.md b/ruma-client/README.md index 4f60002d..9f37f902 100644 --- a/ruma-client/README.md +++ b/ruma-client/README.md @@ -4,34 +4,13 @@ [![docs.rs page](https://docs.rs/ruma-client/badge.svg)](https://docs.rs/ruma-client/) ![license: MIT](https://img.shields.io/crates/l/ruma-client.svg) -**ruma-client** is a [Matrix][] client library for [Rust][]. +**ruma-client** is a low-level [Matrix][] client library for [Rust][]. [Matrix]: https://matrix.org/ [Rust]: https://www.rust-lang.org/ ## Status -This project is a work in progress and not ready for production usage yet. Most endpoints that are -available in this crate are usable with an up-to-date synapse server, but no comprehensive testing -has been done so far. - -As long as the matrix client-server API is still at version 0.x, only the latest API revision is -considered supported. However, due to the low amount of available manpower, it can take a long time -for all changes from a new API revision to arrive in ruma-client (at the time of writing only few -endpoints have received an update for r0.4.0). - -## Contributing - -If you want to help out, have a look at the issues here and on the other [ruma-\*][gh-org] -repositories (ruma-client-api and ruma-events in particular contain much of the code that powers -ruma-client). - -There is also a [room for ruma on matrix.org][#ruma:matrix.org], which can be used for questions -and discussion related to any of the crates in this project. - -[gh-org]: https://github.com/ruma -[#ruma:matrix.org]: https://matrix.to/#/#ruma:matrix.org - -## Minimum Rust version - -ruma-client requires Rust 1.39.0 or later. +This project is a work in progress and not ready for production usage yet. If you are looking to +build a client application or a bot, you are likely going to have a better time using the Matrix +Rust SDK, which also builds on the other Ruma crates but provides a higher-level API. diff --git a/ruma-common/README.md b/ruma-common/README.md index ad707407..9ce0ba00 100644 --- a/ruma-common/README.md +++ b/ruma-common/README.md @@ -1,7 +1,7 @@ # ruma-common -Common types for other ruma crates. +[![crates.io page](https://img.shields.io/crates/v/ruma-common.svg)](https://crates.io/crates/ruma-common) +[![docs.rs page](https://docs.rs/ruma-common/badge.svg)](https://docs.rs/ruma-common/) +![license: MIT](https://img.shields.io/crates/l/ruma-common.svg) -This crate is meant to be a dependency for other ruma crates only, consumers of -those crates should never have to use this directly (its types will be -re-exported from the other crates). +Common types for other Ruma crates. diff --git a/ruma-events-macros/README.md b/ruma-events-macros/README.md index 03c74532..c45254a1 100644 --- a/ruma-events-macros/README.md +++ b/ruma-events-macros/README.md @@ -3,7 +3,3 @@ **ruma-events-macros** provides a procedural macro for easily generating event types for [ruma-events]. [ruma-events]: https://github.com/ruma/ruma/tree/master/ruma-events - -## Documentation - -ruma-events-macros has [comprehensive documentation](https://docs.rs/ruma-events-macros) available on docs.rs. diff --git a/ruma-events/README.md b/ruma-events/README.md index 85208c25..a9e499f1 100644 --- a/ruma-events/README.md +++ b/ruma-events/README.md @@ -5,7 +5,3 @@ ![license: MIT](https://img.shields.io/crates/l/ruma-events.svg) **ruma-events** contains serializable types for the events in the [Matrix](https://matrix.org/) specification that can be shared by client and server code. - -## Documentation - -ruma-events has [comprehensive documentation](https://docs.rs/ruma-events) available on docs.rs. diff --git a/ruma-federation-api/README.md b/ruma-federation-api/README.md index 65cf924e..de8d8c9e 100644 --- a/ruma-federation-api/README.md +++ b/ruma-federation-api/README.md @@ -2,6 +2,3 @@ **ruma-federation-api** contains serializable types for the requests and responses for each endpoint in the [Matrix](https://matrix.org/) Federation API specification. These types can be shared by client and server code. - -## Documentation -[https://docs.rs/ruma-federation-api](https://docs.rs/ruma-federation-api) diff --git a/ruma-identifiers/README.md b/ruma-identifiers/README.md index 74102fdd..d9f6066f 100644 --- a/ruma-identifiers/README.md +++ b/ruma-identifiers/README.md @@ -5,7 +5,3 @@ ![license: MIT](https://img.shields.io/crates/l/ruma-identifiers.svg) **ruma-identifiers** contains types for [Matrix](https://matrix.org/) identifiers for events, rooms, room aliases, and users. - -## Documentation - -ruma-identifiers has [comprehensive documentation](https://docs.rs/ruma-identifiers) available on docs.rs. diff --git a/ruma-signatures/README.md b/ruma-signatures/README.md index 08e030d9..4b0cbb57 100644 --- a/ruma-signatures/README.md +++ b/ruma-signatures/README.md @@ -5,7 +5,3 @@ ![license: MIT](https://img.shields.io/crates/l/ruma-signatures.svg) ruma-signatures provides functionality for creating digital signatures according to the [Matrix](https://matrix.org/) specification. - -## Documentation - -ruma-signatures has [comprehensive documentation](https://docs.rs/ruma-signatures) available on docs.rs. diff --git a/ruma/README.md b/ruma/README.md index c2b14e2b..067f93e5 100644 --- a/ruma/README.md +++ b/ruma/README.md @@ -16,7 +16,3 @@ following features: * `client-api` for the client-server API * `federation-api` for the server-server (federation) API * `appservice-api` for the application service API - -## Documentation - -ruma has [comprehensive documentation](https://docs.rs/ruma) available on docs.rs.