Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ exclude = [
resolver = "2"

[workspace.package]
version = "0.8.0"
version = "0.8.1"
authors = ["kalwalt <github@kalwaltart.it>"]
edition = "2021"
description = "A high-performance, memory-safe Rust port of WebARKitLib (ARToolKit) for native and WASM."
Expand Down
4 changes: 3 additions & 1 deletion crates/wasm/pkg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion crates/wasm/pkg/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
Loading