diff --git a/CHANGELOG.md b/CHANGELOG.md index 5f07f4b..0643e3c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,39 @@ -# Changelog - webarkit/webarkitlib-rs +๏ปฟ# Changelog - webarkit/webarkitlib-rs All notable changes to this project will be documented in this file. +## [0.8.1] - 2026-08-06 + +## Stabilization & DX โ€” benchmarks, coverage, and full API documentation + +### โšก Performance + +- *(kpm)* Add dedicated kpm_bench.rs Criterion benchmark (#225) + +### ๐Ÿ› Bug Fixes + +- *(ci)* Commit Cargo.lock for reproducible coverage/CI (#224) +- *(kpm)* Exempt bindgen-generated bindings from the missing_docs gate (#226) + +### ๐Ÿ“š Documentation + +- *(maintainers)* Document committed Cargo.lock + deliberate dep updates +- *(benches)* Document kpm_bench + drop stale "no KPM benchmark" claim (#225) +- *(kpm)* Correct stale backend docs + document KPM public API (#226) +- *(contributing)* Document the libclang/bindgen ffi-backend build failure (#226) +- *(wasm)* Add JS/TS integration guide + link from README (#226) +- *(ar2,icp)* Document the AR2 tracking + ICP public API (#226) +- *(core)* Document remaining public API + enable crate-wide missing_docs (#226) +- *(kpm)* Rationale comments for kpm/freak too_many_arguments allows (#83) + +### ๐Ÿšœ Refactor + +- *(ar,ar2)* Group params in private helpers + document allows (#83) + +### ๐Ÿงช Testing + +- *(core)* Cover error/validation branches in ar/pattern.rs + kpm/freak/pyramid.rs (#224) + ## [0.8.0] - 2026-06-26 ## Milestone โ€” Pure-Rust completeness, validation & polish diff --git a/Cargo.lock b/Cargo.lock index d098802..1b2d681 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2122,7 +2122,7 @@ dependencies = [ [[package]] name = "webarkitlib-rs" -version = "0.8.0" +version = "0.8.1" dependencies = [ "bindgen", "byteorder", @@ -2146,7 +2146,7 @@ dependencies = [ [[package]] name = "webarkitlib-wasm" -version = "0.8.0" +version = "0.8.1" dependencies = [ "console_error_panic_hook", "js-sys", diff --git a/Cargo.toml b/Cargo.toml index 3f4caa2..1a5a94c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -9,7 +9,7 @@ exclude = [ resolver = "2" [workspace.package] -version = "0.8.0" +version = "0.8.1" authors = ["kalwalt "] edition = "2021" description = "A high-performance, memory-safe Rust port of WebARKitLib (ARToolKit) for native and WASM." diff --git a/crates/wasm/pkg/README.md b/crates/wasm/pkg/README.md index 2e08be4..785f431 100644 --- a/crates/wasm/pkg/README.md +++ b/crates/wasm/pkg/README.md @@ -209,7 +209,9 @@ For integration into your own project, install the pre-built package from npm npm install @webarkit/webarkitlib-wasm ``` -See [@webarkit/webarkitlib-wasm](https://www.npmjs.com/package/@webarkit/webarkitlib-wasm) for API documentation and usage examples. +๐Ÿ“– **[WebAssembly (JS/TS) integration guide](https://github.com/webarkit/WebARKitLib-rs/blob/main/docs/wasm-js-integration.md)** โ€” a full walkthrough: loading and initializing the module, the standard vs SIMD engines, the three handles (`WasmARHandle` / `WasmKpmHandle` / `WasmNFTHandle`), the NFT detect-then-track loop, the pose-matrix layout, TypeScript usage, and memory management. + +See also [@webarkit/webarkitlib-wasm](https://www.npmjs.com/package/@webarkit/webarkitlib-wasm) on npm. #### Running the bundled demos diff --git a/crates/wasm/pkg/package.json b/crates/wasm/pkg/package.json index 3bef609..8d16cb5 100644 --- a/crates/wasm/pkg/package.json +++ b/crates/wasm/pkg/package.json @@ -5,7 +5,7 @@ "kalwalt \u003cgithub@kalwaltart.it\u003e" ], "description": "A high-performance, memory-safe Rust port of WebARKitLib (ARToolKit) for native and WASM.", - "version": "0.8.0", + "version": "0.8.1", "license": "LGPL-3.0-or-later", "repository": { "type": "git", diff --git a/package.json b/package.json index f520df7..aca7bc8 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "webarkitlib-rs", - "version": "0.8.0", + "version": "0.8.1", "description": "Port of WebARKitLib (ARToolKit) to Rust and WASM", "private": true, "scripts": {