scanic 0.1.5 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +16 -2
  2. package/package.json +10 -2
package/README.md CHANGED
@@ -1,9 +1,16 @@
1
1
  <p align="center">
2
2
  <a href="#">
3
- <img src="./public/scanic-logo-bg.png" alt="scanic logo" height="400">
3
+ <img src="public/scanic-logo-bg.png" alt="scanic logo" height="400">
4
4
  </a>
5
5
  </p>
6
6
 
7
+ <p align="center">
8
+ <a href="https://npmjs.com/package/scanic"><img src="https://badgen.net/npm/dw/scanic"></a>
9
+ <br />
10
+ <a href="https://github.com/marquaye/scanic/blob/master/LICENSE"><img src="https://img.shields.io/github/license/marquaye/scanic.svg"></a>
11
+ <a href="https://npmjs.com/package/jscanic"><img src="https://badgen.net/npm/v/scanic"></a>
12
+ </p>
13
+
7
14
  # Scanic
8
15
 
9
16
  **Modern Document Scanner for the Web**
@@ -48,7 +55,7 @@ Or use via CDN:
48
55
  ## Usage
49
56
 
50
57
  ```js
51
- import { scanDocument, LiveScanner, checkWebcamAvailability } from 'scanic';
58
+ import { scanDocument } from 'scanic';
52
59
 
53
60
  // Simple usage - just detect document
54
61
  const result = await scanDocument(imageElement);
@@ -167,6 +174,13 @@ const rawData = await scanDocument(imageElement, {
167
174
  mode: 'extract',
168
175
  output: 'imagedata'
169
176
  });
177
+
178
+ // Extract as DataURI
179
+ const rawData = await scanDocument(imageElement, {
180
+ mode: 'extract',
181
+ output: 'dataurl'
182
+ });
183
+
170
184
  ```
171
185
 
172
186
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "scanic",
3
- "version": "0.1.5",
3
+ "version": "0.1.6",
4
4
  "description": "Modern document scanner in pure JavaScript and Wasm",
5
5
  "type": "module",
6
6
  "main": "dist/scanic.umd.js",
@@ -23,8 +23,16 @@
23
23
  "contour",
24
24
  "detection"
25
25
  ],
26
- "author": "",
26
+ "author": "marquaye",
27
27
  "license": "MIT",
28
+ "repository": {
29
+ "type": "git",
30
+ "url": "https://github.com/marquaye/scanic.git"
31
+ },
32
+ "homepage": "https://github.com/marquaye/scanic",
33
+ "bugs": {
34
+ "url": "https://github.com/marquaye/scanic/issues"
35
+ },
28
36
  "files": [
29
37
  "dist",
30
38
  "wasm_blur/pkg",