scanic 1.0.5 → 1.0.7

package/README.md

@@ -17,7 +17,7 @@
 
 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/demo.html) | [**Framework Examples**](#💻-framework-examples) | [**API Reference**](#⚙️-api-reference)
+[**Live Demo**](https://marquaye.github.io/scanic) | [**Framework Examples**](#💻-framework-examples) | [**API Reference**](#⚙️-api-reference)
 
 ---
 
@@ -43,6 +43,13 @@ Traditional web scanning solutions often force a trade-off:
 - 📦 **Featherweight**: Under **100KB** total size (gzipped).
 - 🧪 **Production Grade**: Built-in regression tests with physical image baselines.
 
+## 🆕 What's New (v1.0.7)
+
+- 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.
+
 ---
 
 ## 🛠️ Installation
@@ -65,7 +72,7 @@ yarn add scanic
 ## 🎮 Demo
 
 Try the interactive scanner in your browser:
-👉 [**Open Scanic Live Demo**](https://marquaye.github.io/scanic/demo.html)
+👉 [**Open Scanic Live Demo**](https://marquaye.github.io/scanic)
 
 ---
 
@@ -163,9 +170,18 @@ The primary function for detecting and extracting documents.
 | `mode` | `'detect' \| 'extract'` | `'detect'` | `'detect'` returns coordinates; `'extract'` returns the warped image. |
 | `output` | `'canvas' \| 'imagedata' \| 'dataurl'` | `'canvas'` | The format of the returned processed image. |
 | `maxProcessingDimension` | `number` | `800` | Downscales image to this size for detection (faster). |
-| `lowThreshold` | `number` | `75` | Lower threshold for Canny edge detection. |
-| `highThreshold` | `number` | `200` | Upper threshold for Canny edge detection. |
+| `lowThreshold` | `number` | `adaptive` | Optional lower threshold for Canny edge detection. If omitted together with `highThreshold`, adaptive thresholds are used. |
+| `highThreshold` | `number` | `adaptive` | Optional upper threshold for Canny edge detection. |
+| `applyDilation` | `boolean` | `true` | Enables dilation in the primary pass. |
+| `dilationKernelSize` | `number` | `3` | Morphological dilation kernel size for edge connection. |
+| `dilationIterations` | `number` | `1` | Number of dilation passes. |
 | `minArea` | `number` | `1000` | Minimum pixel area to consider a contour a "document". |
+| `enableDetectionCascade` | `boolean` | `true` | Enables fallback pass profiles for hard images. |
+| `minCascadeTriggerConfidence` | `number` | `0.68` | Confidence threshold before trying additional pass profiles. |
+| `maxCandidateContours` | `number` | `12` | Number of largest contours to score per pass. |
+| `minDocumentCoverageRatio` | `number` | `0.04` | Minimum image coverage required for a valid candidate. |
+| `minDocumentFillRatio` | `number` | `0.07` | Minimum contour fill ratio within its bounding box. |
+| `maxDocumentAspectRatio` | `number` | `8` | Maximum accepted aspect ratio for candidates. |
 | `debug` | `boolean` | `false` | If true, returns intermediate processing steps. |
 
 #### Return Value
@@ -312,7 +328,7 @@ const result = await scanDocument(img, { mode: 'extract' });
 
 | Feature | Scanic | jscanify | OpenCV.js |
 | :--- | :--- | :--- | :--- |
-| **Download Size** | **~100KB** | ~1MB | ~30MB |
+| **Download Size** | **~100KB** | ~31MB | ~30MB |
 | **Perspective Speed** | **~10ms** | ~200ms | ~5ms |
 | **WASM Optimized** | ✅ Yes | ❌ No | ✅ Yes |
 | **GPU Acceleration** | ✅ Yes | ❌ No | ❌ No |
@@ -388,6 +404,14 @@ Contributions are welcome! Whether it's reporting a bug, suggesting a feature, o
       <br/>
       <em>Language and translation services</em>
     </td>
+    <td align="center" width="250">
+      <a href="https://mein-kreativbuch.de/" target="_blank">
+        <br/>
+        <strong>mein-kreativbuch.de</strong>
+      </a>
+      <br/>
+       <em>Unique and personalized children's books</em>
+    </td>
   </tr>
 </table>