diff options
author | RaindropsSys <contact@minteck.org> | 2023-04-24 14:03:36 +0200 |
---|---|---|
committer | RaindropsSys <contact@minteck.org> | 2023-04-24 14:03:36 +0200 |
commit | 633c92eae865e957121e08de634aeee11a8b3992 (patch) | |
tree | 09d881bee1dae0b6eee49db1dfaf0f500240606c /includes/external/matrix/node_modules/@matrix-org/matrix-sdk-crypto-js/README.md | |
parent | c4657e4509733699c0f26a3c900bab47e915d5a0 (diff) | |
download | pluralconnect-633c92eae865e957121e08de634aeee11a8b3992.tar.gz pluralconnect-633c92eae865e957121e08de634aeee11a8b3992.tar.bz2 pluralconnect-633c92eae865e957121e08de634aeee11a8b3992.zip |
Updated 18 files, added 1692 files and deleted includes/system/compare.inc (automated)
Diffstat (limited to 'includes/external/matrix/node_modules/@matrix-org/matrix-sdk-crypto-js/README.md')
-rw-r--r-- | includes/external/matrix/node_modules/@matrix-org/matrix-sdk-crypto-js/README.md | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/includes/external/matrix/node_modules/@matrix-org/matrix-sdk-crypto-js/README.md b/includes/external/matrix/node_modules/@matrix-org/matrix-sdk-crypto-js/README.md new file mode 100644 index 0000000..33ea75e --- /dev/null +++ b/includes/external/matrix/node_modules/@matrix-org/matrix-sdk-crypto-js/README.md @@ -0,0 +1,57 @@ +# `matrix-sdk-crypto-js` + +Welcome to the [WebAssembly] + JavaScript binding for the Rust +[`matrix-sdk-crypto`] library! WebAssembly can run anywhere, but these +bindings are designed to run on a JavaScript host. These bindings are +part of the [`matrix-rust-sdk`] project, which is a library +implementation of a [Matrix] client-server. + +`matrix-sdk-crypto` is a no-network-IO implementation of a state +machine, named `OlmMachine`, that handles E2EE ([End-to-End +Encryption](https://en.wikipedia.org/wiki/End-to-end_encryption)) for +[Matrix] clients. + +## Usage + +These WebAssembly bindings are written in [Rust]. To build them, you +need to install the Rust compiler, see [the Install Rust +Page](https://www.rust-lang.org/tools/install). Then, the workflow is +pretty classical by using [npm], see [the Downloading and installing +Node.js and npm +Page](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). + +Once the Rust compiler, Node.js and npm are installed, you can run the +following commands: + +```sh +$ npm install +$ npm run build +$ npm run test +``` + +A `matrix_sdk_crypto.js`, `matrix_sdk_crypto.d.ts` and a +`matrix_sdk_crypto_bg.wasm` files should be generated in the `pkg/` +directory. + +TBD + +## Documentation + +[The documentation can be found +online](https://matrix-org.github.io/matrix-rust-sdk/bindings/matrix-sdk-crypto-js/). + +To generate the documentation locally, please run the following +command: + +```sh +$ npm run doc +``` + +The documentation is generated in the `./docs` directory. + +[WebAssembly]: https://webassembly.org/ +[`matrix-sdk-crypto`]: https://github.com/matrix-org/matrix-rust-sdk/tree/main/crates/matrix-sdk-crypto +[`matrix-rust-sdk`]: https://github.com/matrix-org/matrix-rust-sdk +[Matrix]: https://matrix.org/ +[Rust]: https://www.rust-lang.org/ +[npm]: https://www.npmjs.com/ |