scanic 1.1.1 → 1.3.0

package/README.md

@@ -7,17 +7,19 @@
 <p align="center">
     <a href="https://npmjs.com/package/scanic"><img src="https://badgen.net/npm/dw/scanic"></a>
     <br />
-    <a href="https://github.com/marquaye/scanic/blob/master/LICENSE"><img src="https://img.shields.io/github/license/marquaye/scanic.svg"></a>
+    <a href="https://github.com/marquaye/scanic/blob/main/LICENSE"><img src="https://img.shields.io/github/license/marquaye/scanic.svg"></a>
     <a href="https://npmjs.com/package/scanic"><img src="https://badgen.net/npm/v/scanic"></a>
+    <a href="https://bundlephobia.com/package/scanic"><img src="https://img.shields.io/bundlephobia/minzip/scanic"></a>
+    <a href="https://marquaye.github.io/scanic"><img src="https://img.shields.io/badge/docs-online-6366f1"></a>
 </p>
 
-# Scanic 📄⚡
+# Scanic
 
 **Ultra-fast, production-ready document scanning for the modern Web.**
 
 Scanic is a high-performance document scanner library that brings professional-grade document edge detection and perspective correction to the browser and Node.js. By combining **Rust-powered WebAssembly** for pixel crunching and **GPU-accelerated Canvas** for image warping, Scanic delivers near-native performance (~10ms transforms) with a tiny footprint.
 
-[**Live Demo**](https://marquaye.github.io/scanic) | [**Framework Examples**](#💻-framework-examples) | [**API Reference**](#⚙️-api-reference)
+[**Documentation**](https://marquaye.github.io/scanic) | [**Live Demo**](https://marquaye.github.io/scanic/demo/) | [**Framework Examples**](#💻-framework-examples) | [**API Reference**](https://marquaye.github.io/scanic/api/reference)
 
 ---
 
@@ -41,14 +43,17 @@ Traditional web scanning solutions often force a trade-off:
 - 🦀 **WASM Core**: High-performance Gaussian Blur, Canny Edge Detection, and Dilation.
 - 🛠️ **Modern API**: Clean, Promise-based API with full **TypeScript** support.
 - 📦 **Featherweight**: Under **100KB** total size (gzipped).
+- 🤖 **Optional ML detector**: opt into a neural corner detector for hard photos — lazy-loaded, zero cost to classical users. See the [ML Detection guide](https://marquaye.github.io/scanic/guide/ml-detection).
 - 🧪 **Production Grade**: Built-in regression tests with physical image baselines.
 
-## 🆕 What's New (v1.0.7)
+## 🆕 What's New
 
-- Improved default document quality with adaptive multi-pass candidate evaluation.
-- More stable corners on noisy contours through multi-epsilon approximation and duplicate-vertex cleanup.
-- Expanded debug tooling with full test image coverage and corner delta comparison against jscanify.
-- Expanded live demo sample set for broader real-world validation.
+See the [**full documentation**](https://marquaye.github.io/scanic), the
+[**changelog**](CHANGELOG.md), and the [**releases**](https://github.com/marquaye/scanic/releases)
+for the latest. Recent highlights:
+
+- **Styleable corner editor** — a built-in, touch-friendly UI to fine-tune detected corners, now fully themeable via CSS variables with a polished default toolbar. See the [corner editor guide](https://marquaye.github.io/scanic/guide/corner-editor).
+- **New docs site** with guides for Web/Node.js/Electron/React/Vue and an interactive in-browser playground.
 
 ---
 
@@ -72,7 +77,7 @@ yarn add scanic
 ## 🎮 Demo
 
 Try the interactive scanner in your browser:
-👉 [**Open Scanic Live Demo**](https://marquaye.github.io/scanic)
+👉 [**Open Scanic Live Demo**](https://marquaye.github.io/scanic/demo/)
 
 ---
 
@@ -284,8 +289,8 @@ Scanic is framework-agnostic but works great with modern UI libraries:
 
 | Framework | Link |
 | :--- | :--- |
-| **Vue 3** | [Vue.js Example & Guide](docs/vue-example.md) |
-| **React** | [React Example & Guide](docs/react-example.md) |
+| **Vue 3** | [Vue & React Guide](https://marquaye.github.io/scanic/guide/frameworks) |
+| **React** | [Vue & React Guide](https://marquaye.github.io/scanic/guide/frameworks) |
 
 ---
 
@@ -447,12 +452,7 @@ Contributions are welcome! Whether it's reporting a bug, suggesting a feature, o
 
 ## 🗺️ Roadmap
 
-- [x] TypeScript definitions
-- [x] High-performance perspective transformation (Triangle Subdivision)
-- [ ] Enhanced WASM module with additional Rust-optimized algorithms
-- [ ] WebGPU acceleration for supported browsers
-- [ ] Mobile-optimized real-time video processing frames
-- [ ] Additional image enhancement filters (Adaptive Thresholding, B&W)
+See [**ROADMAP.md**](ROADMAP.md) for what's shipped and what's planned.
 
 ## License