update readme now that build process include correct metadata

Author: rsoury

.github/workflows/release-verifier.yml

@@ -28,7 +28,7 @@ jobs:
       - name: Install build dependencies
         run: |
           sudo apt-get update
-          sudo apt-get install -y binaryen
+          sudo apt-get install -y jq
           cargo install --locked wasi2ic candid-extractor ic-wasm
 
       - name: Install DFX

Cargo.lock

@@ -14,7 +14,7 @@ members = [
 resolver = "2"
 
 [workspace.package]
-version = "0.2.6-rc.6"
+version = "0.2.6"
 authors = ["Usher Labs <labs@usher.so>"]
 repository = "https://github.com/usherlabs/verity-dp"
 homepage = "https://www.usher.so/"

Cargo.toml

@@ -1,12 +1,36 @@
-# Verity Managed *General Purpose MPC-TLS* Verifier
+# Verity Managed *General-purpose MPC-TLS* Verifier
 
-To learn about the Verity Verifier in detail, please refer to the [official documentation](https://docs.verity.usher.so/), specifically the [Verity Verifier](https://docs.verity.usher.so/build/verifier) section.
+For detailed information about the Verity Verifier, see the [official documentation](https://docs.verity.usher.so/), specifically the [Verity Verifier](https://docs.verity.usher.so/build/verifier) section.
 
-**The following is from the documentation as of *23 January 2025*.**
+**The following content reflects the documentation as at 23 January 2025.**
+
+## Use the Verifier as a Dependency in Your Canister
+
+The Verifier can now be used as a dependency in other canisters.
+
+Update your `dfx.json` to include:
+
+```json
+{
+  "canisters": {
+    "<your_canister>": {
+      .....
+      "dependencies": [
+        "verity_verifier"
+      ]
+    },
+    "verity_verifier": {
+      "type": "pull",
+      "id": "yf57k-fyaaa-aaaaj-azw2a-cai"
+    }
+  }
+}
+
+``` 
 
 ## Local Deployment
 
-**Disclaimer:** Deployment of the canister (`ic/managed/verifier`) to mainnet is not recommended. This is to ensure compliance with licence agreements and to maintain compatibility and security with the broader Verity Network. We recommend using our Managed *General Purpose MPC-TLS* Verifier and interfacing via an inter-canister `async` calls or a wallet‑to‑IC `direct` calls for optimal security and performance.
+**Disclaimer:** Deployment of this canister (`ic/managed/verifier`) to the mainnet is not recommended. This is to ensure compliance with licence agreements and to maintain compatibility and security across the broader Verity Network. We recommend using our managed *General-purpose MPC-TLS* Verifier and interfacing via inter‑canister `async` calls or wallet‑to‑IC `direct` calls for optimal security and performance.
 
 ### Prerequisites
 
@@ -16,26 +40,12 @@ To learn about the Verity Verifier in detail, please refer to the [official docu
 rustup target add wasm32-wasip1
 ```
 
-2. Install `wasi2ic`:
+2. Install `wasi2ic`, `candid-extractor`, and `ic-wasm`:
 
 ```bash
-cargo install wasi2ic
+cargo install wasi2ic candid-extractor ic-wasm
 ```
 
-3. Install `binaryen`:
-
-   With Homebrew:
-
-   ```bash
-   brew install binaryen
-   ```
-
-   From the releases page:
-   1. Download [Binaryen](https://github.com/WebAssembly/binaryen/releases) from the releases page.
-   2. Extract the files: `tar -xzf binaryen-version.tar.gz`.
-   3. Move the binary to your PATH: `sudo mv binaryen-version/bin/wasm-opt /usr/local/bin/`.
-   4. Verify the installation: `wasm-opt --version`.
-
 ### Deployment
 
 To deploy the canister locally, follow these steps:
@@ -48,25 +58,25 @@ To deploy the canister locally, follow these steps:
 1. `pnpm prep`
 2. `pnpm test --run`
 
-### Performance benchmarks
+### Performance Benchmarks
 
 We have benchmarked the following functions to provide insight into their performance:
 
 #### `verify_proof_async` and `verify_proof_async_batch`
 
-- **Execution time:** Constant, regardless of input size (~2100 ms).
+- **Execution time:** Constant, regardless of input size (≈ 2,100 ms).
 - **DFX cycle cost:** Approximately 550–720 cycles per byte of TLS data.
 
 #### `verify_proof_direct` and `verify_proof_direct_batch`
 
-- **Execution time:** Linear; approximately 3× the execution time of `verify_proof_async` plus signing time (L).
+- **Execution time:** Approximately linear; about 3× the execution time of `verify_proof_async`, plus signing time.
 - **DFX cycle cost:** Roughly the same as `verify_proof_async` and `verify_proof_async_batch`.
 
 ### Caveats
 
-#### `clang` dependency
+#### Clang dependency
 
-**On macOS:** If you experience issues during `cargo build` where the `ring` library fails to compile, this is typically because `clang` is not found.
+**On macOS:** If you encounter issues during `cargo build` where the `ring` library fails to compile, it is typically because `clang` is not found.
 
 To resolve this:
 
@@ -82,12 +92,12 @@ brew install llvm
 echo 'PATH="$(brew --prefix llvm)/bin${PATH:+:${PATH}}"; export PATH;' >> ~/.zshrc
 ```
 
-#### `etherum_pk`
+#### `etherum_pk` (typo)
 
-The `etherum_pk` field in the `PublicKeyReply` struct is the Ethereum address derived from the SEC1 public key. This is obtained using the `get_address_from_public_key` function in the `ethereum` module.
+The `etherum_pk` field in the `PublicKeyReply` struct is the Ethereum address derived from the SEC1 public key. It is obtained using the `get_address_from_public_key` function in the `ethereum` module.
 
 ```rust
 let address = ethereum::get_address_from_public_key(res.public_key.clone()).expect("INVALID_PUBLIC_KEY");
 ```
 
-*It should be spelled `ethereum_pk`, not `etherum_pk`.*
+Note: The correct field name is `ethereum_pk`, not `etherum_pk`.