diff --git a/CHANGELOG.md b/CHANGELOG.md index 2d58de47e..84777a05a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ## 0.13.0 (TBD) +* Added TypeDoc API reference links for web SDK in main README and Docusaurus documentation ([#1356](https://github.com/0xMiden/miden-client/issues/1356)). * [BREAKING] Removed `getRpoFalcon512PublicKeyAsWord` and `getEcdsaK256KeccakPublicKeyAsWord` in `AuthSecretKey` * Improved auth scheme handling across the Rust and web clients (typed `build_wallet_id`, unified transaction tests, new shared `getPublicKeyAsWord` binding, and refreshed typedoc output) ([#1556](https://github.com/0xMiden/miden-client/pull/1556)). * [BREAKING] Typed the `auth_scheme` plumbing across the Rust WebClient ID-building helpers and aligned the WebClient bindings with the native enum to avoid passing raw identifiers ([#1546](https://github.com/0xMiden/miden-client/pull/1546)). diff --git a/README.md b/README.md index b9f8a1d8a..5f80ef971 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,11 @@ The Miden client is still under heavy development and the project can be conside ## Overview -The Miden client currently consists of two components: +The Miden client currently consists of three components: - `miden-client` library, which can be used by other project to programmatically interact with the Miden rollup. You can find more information about the library in the [Rust client Library](./crates/rust-client/README.md) section. - `miden-client-cli`, which is a wrapper around the library exposing its functionality via a simple command-line interface (CLI). You can find more information about the CLI in the [Miden client CLI](./bin/miden-cli/README.md) section. +- `@miden-sdk/miden-sdk` (web client), which is a browser-focused SDK for interacting with the Miden rollup from web applications. You can find more information about the web client in the [Web Client README](./crates/web-client/README.md) section. The client's main responsibility is to maintain a partial view of the blockchain which allows for locally executing and proving transactions. It keeps a local store of various entities that periodically get updated by syncing with the node. diff --git a/docs/external/src/web-client/index.md b/docs/external/src/web-client/index.md index fd83c4059..101ae4774 100644 --- a/docs/external/src/web-client/index.md +++ b/docs/external/src/web-client/index.md @@ -38,3 +38,7 @@ yarn add @demox-labs/miden-sdk ``` See the [README](https://github.com/0xMiden/miden-client/blob/main/crates/web-client/README) for full installation instructions and some usage instructions, including code examples for wallet creation, transaction execution, and syncing state. + +## API Reference + +For complete API documentation, see the [TypeDoc API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).