chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Various README updates

Browse Source
This commit is contained in:
Jonas Platte 2020-09-29 20:30:33 +02:00
parent 8b9e20b842
commit 006582e3f2
No known key found for this signature in database
GPG Key ID: 7D261D771D915378
12 changed files with 23 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,12 +1,21 @@
# Ruma – Your home in Matrix. # 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] • [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 [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 ## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md). See [CONTRIBUTING.md](CONTRIBUTING.md).

6
ruma-api-macros/README.md
View File

@ -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

4
ruma-api/README.md
View File

@ -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. **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. 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.

4
ruma-appservice-api/README.md
View File

@ -1,5 +1,9 @@
# ruma-appservice-api # 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. **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. These types can be shared by application service and server code.

29
ruma-client/README.md
View File

@ -4,34 +4,13 @@
[![docs.rs page](https://docs.rs/ruma-client/badge.svg)](https://docs.rs/ruma-client/) [![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) ![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/ [Matrix]: https://matrix.org/
[Rust]: https://www.rust-lang.org/ [Rust]: https://www.rust-lang.org/
## Status ## Status
This project is a work in progress and not ready for production usage yet. Most endpoints that are This project is a work in progress and not ready for production usage yet. If you are looking to
available in this crate are usable with an up-to-date synapse server, but no comprehensive testing build a client application or a bot, you are likely going to have a better time using the Matrix
has been done so far. Rust SDK, which also builds on the other Ruma crates but provides a higher-level API.
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.

8
ruma-common/README.md
View File

@ -1,7 +1,7 @@
# ruma-common # 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 Common types for other Ruma crates.
those crates should never have to use this directly (its types will be
re-exported from the other crates).

4
ruma-events-macros/README.md
View File

@ -3,7 +3,3 @@
**ruma-events-macros** provides a procedural macro for easily generating event types for [ruma-events]. **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 [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.

4
ruma-events/README.md
View File

@ -5,7 +5,3 @@
![license: MIT](https://img.shields.io/crates/l/ruma-events.svg) ![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. **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.

3
ruma-federation-api/README.md
View File

@ -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. **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. These types can be shared by client and server code.
## Documentation
[https://docs.rs/ruma-federation-api](https://docs.rs/ruma-federation-api)

4
ruma-identifiers/README.md
View File

@ -5,7 +5,3 @@
![license: MIT](https://img.shields.io/crates/l/ruma-identifiers.svg) ![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. **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.

4
ruma-signatures/README.md
View File

@ -5,7 +5,3 @@
![license: MIT](https://img.shields.io/crates/l/ruma-signatures.svg) ![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. 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.

4
ruma/README.md
View File

@ -16,7 +16,3 @@ following features:
* `client-api` for the client-server API * `client-api` for the client-server API
* `federation-api` for the server-server (federation) API * `federation-api` for the server-server (federation) API
* `appservice-api` for the application service API * `appservice-api` for the application service API
## Documentation
ruma has [comprehensive documentation](https://docs.rs/ruma) available on docs.rs.