mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-05-14 19:16:02 -04:00
39077b185b
This patch adds a new `npm run publish` script that: 1. Run `npm run prepublish` (which runs the `build` and `test` scripts), 2. Run `wasm-pack publish`. Note 1: The `prepublish` script is using the `$npm_execpath` environment variable instead of just “`npm`”, so that if someone is using `yarn` or another JavaScript package manager, it _should_ work (not tested yet). Note 2: `wasm-pack publish` is run without running `wasm-pack login` before that. _But_ we are updating the registry URL in the NPM configuration file in the Github Action workflow, see below. This patch then creates a new Github Action workflow that is triggered when a new tag of the form `matrix-sdk-crypto-js-v[0_9]+.*` is pushed. This workflow runs `npm run publish` basically, but before that, it updates the NPM configuration file by setting a value for `//registry.npmjs.org/:_authToken`. Thus, running `wasm-pack login` is not necessary.
matrix-rust-sdk
matrix-rust-sdk is an implementation of a Matrix client-server library in Rust.
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.
Minimum Supported Rust Version (MSRV)
These crates are built with the Rust language version 2021 and require a minimum compiler version of 1.60
Status
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.
Bindings
Some crates of the matrix-rust-sdk can be embedded inside other
environments, like Swift, Kotlin, JavaScript, Node.js etc. Please,
explore the bindings/ directory to learn more.