wickra-benchmark-wasm 0.1.2 → 0.1.3

package/README.md

@@ -1,5 +1,18 @@
+<p align="center">
+  <a href="https://wickra.org"><img src="https://raw.githubusercontent.com/wickra-lib/.github/main/profile/wickra-banner.webp?v=514-7" alt="Wickra Benchmark — a reproducible, golden-verified benchmark suite for quant backtests, recomputable byte-for-byte in ten languages" width="100%"></a>
+</p>
+
+[![CI](https://raw.githubusercontent.com/wickra-lib/.github/main/profile/badges/wickra-benchmark/ci.svg)](https://github.com/wickra-lib/wickra-benchmark/actions/workflows/ci.yml)
+[![codecov](https://raw.githubusercontent.com/wickra-lib/.github/main/profile/badges/wickra-benchmark/codecov.svg)](https://codecov.io/gh/wickra-lib/wickra-benchmark)
+[![npm](https://raw.githubusercontent.com/wickra-lib/.github/main/profile/badges/wickra-benchmark/npm.svg)](https://www.npmjs.com/package/wickra-benchmark-wasm)
+[![License: MIT OR Apache-2.0](https://raw.githubusercontent.com/wickra-lib/.github/main/profile/badges/wickra-benchmark/license.svg)](https://github.com/wickra-lib/wickra-benchmark#license)
+
 # Wickra Benchmark — WASM
 
+---
+
+**Part of the [Wickra ecosystem](https://github.com/wickra-lib) — for WASM. `npm install wickra-benchmark-wasm` — pure WebAssembly, runs anywhere a modern JS engine does.**
+
 Recompute a curated benchmark case or suite with the deterministic Wickra engine
 and confirm its report and hash, compiled to WebAssembly for the browser (and
 any WASM host). Built with [wasm-bindgen].
@@ -8,7 +21,13 @@ The suite runs sequentially under WASM (no thread pool in a browser sandbox),
 which is byte-identical to the native parallel run — the exact cross-language
 golden check.
 
-## Build
+## Install
+
+```bash
+npm install wickra-benchmark-wasm
+```
+
+### Building from this repository (contributors)
 
 ```sh
 wasm-pack build --target web      # for browsers / bundlers
@@ -18,13 +37,13 @@ wasm-pack build --target nodejs   # for Node.js
 The `pkg/` output (the `.wasm` binary plus the JS glue and TypeScript types) is
 generated, not committed.
 
-## Usage
+## Quick start
 
 Everything goes through a `Benchmark` driven by JSON commands — the same command
 protocol every Wickra binding shares.
 
 ```js
-import init, { Benchmark } from "./pkg/wickra_benchmark_wasm.js";
+import init, { Benchmark } from "wickra-benchmark-wasm";
 
 await init(); // load the .wasm module (web target)
 
@@ -46,7 +65,7 @@ const result = JSON.parse(bench.command(JSON.stringify(runCase)));
 console.log(result.passed && result.hash_match ? "passed" : "failed");
 ```
 
-## Commands
+### Commands
 
 | `cmd`         | Payload             | Response                                |
 |---------------|---------------------|-----------------------------------------|
@@ -61,8 +80,45 @@ array.
 Domain errors (a bad case, an unknown command) come back in-band as
 `{ok:false,error:...}`; a malformed command envelope throws a JS error.
 
-## License
+## Benchmark
+
+Every binding forwards to the same data-driven Rust core, so what this one adds is
+the call overhead of wasm-bindgen, not a different result. The core's throughput is
+measured by the repository's benchmark suite and the nightly `bench.yml` run; the
+numbers, the machine and how to reproduce them are in the repository
+[BENCHMARKS.md](https://github.com/wickra-lib/wickra-benchmark/blob/main/BENCHMARKS.md).
 
-MIT OR Apache-2.0.
+## Documentation
+
+The full guide, the spec reference and the API documentation live in the main
+repository and the documentation site:
+
+- **Repository:** <https://github.com/wickra-lib/wickra-benchmark>
+- **Docs** (guides, spec reference, cookbook): <https://benchmark.wickra.org>
+- **Runnable example:** [`examples/wasm/`](https://github.com/wickra-lib/wickra-benchmark/tree/main/examples/wasm)
+
+Wickra Benchmark ships native bindings for Python, Node.js, WASM and Rust, plus a C ABI hub that any
+C-capable language (C, C++, C#, Go, Java, R) links against — all forwarding to the
+same data-driven, `unsafe`-forbidden Rust core.
+
+## Security
+
+Found a security issue? **Please don't open a public issue.** Report it privately
+via the repository's *Security* tab (*"Report a vulnerability"*) or email
+**support@wickra.org** with a subject line starting `[wickra security]`. Full
+policy: <https://github.com/wickra-lib/wickra-benchmark/blob/main/SECURITY.md>.
+
+## Disclaimer
+
+`wickra-benchmark` is research and engineering tooling, not financial advice. A
+passing case attests only that a report is the deterministic result of a given
+strategy over given data — it makes no claim about the quality, profitability or
+future performance of any strategy, nor about whether the data is representative
+of any market. Trading carries risk; you are responsible for your own decisions.
+`wickra-benchmark` is free software you run yourself: no hosted service, no data
+collection, no warranty.
+
+## License
 
-[wasm-bindgen]: https://github.com/rustwasm/wasm-bindgen
+Licensed under either of [Apache-2.0](https://github.com/wickra-lib/wickra-benchmark/blob/main/LICENSE-APACHE)
+or [MIT](https://github.com/wickra-lib/wickra-benchmark/blob/main/LICENSE-MIT) at your option.

package/package.json

@@ -5,7 +5,7 @@
     "wickra-lib"
   ],
   "description": "WebAssembly bindings for wickra-benchmark — recompute a curated case or suite and confirm its report and hash, in the browser.",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "license": "MIT OR Apache-2.0",
   "repository": {
     "type": "git",