ruwuma/ruma-client/README.md
Jonas Platte 3a6bdd63bd Add 'ruma-client/' from commit 'fab0ef566f143c1926bff4af4a0a4751379eff1f'
git-subtree-dir: ruma-client
git-subtree-mainline: c4558774be98863015c51e0ec8f26b3fe3d4a103
git-subtree-split: fab0ef566f143c1926bff4af4a0a4751379eff1f
2020-08-10 23:49:55 +02:00

1.6 KiB

ruma-client

crates.io page docs.rs page build status license: MIT

ruma-client is a Matrix client library for Rust.

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-* 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, which can be used for questions and discussion related to any of the crates in this project.

Minimum Rust version

ruma-client requires Rust 1.39.0 or later.