LiittleCookie/jscanify
1
0
Fork 0
mirror of https://github.com/ColonelParrot/jscanify.git synced 2025-12-30 22:31:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

README: include badges

Browse Source
This commit is contained in:
ColonelParrot 2023-05-10 15:31:25 -04:00
parent 7ff45d78ae
commit 4a6c9964e9
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -3,6 +3,10 @@
</p> </p>
<p align="center"> <p align="center">
<a href="https://www.jsdelivr.com/package/gh/ColonelParrot/jscanify"><img src="https://data.jsdelivr.com/v1/package/gh/ColonelParrot/jscanify/badge"></a>
<a href="https://cdnjs.com/libraries/jscanify"><img src="https://img.shields.io/cdnjs/v/jscanify"></a>
<a href="https://npmjs.com/package/jscanify"><img src="https://badgen.net/npm/dw/jscanify"></a>
<br />
<a href="https://github.com/ColonelParrot/jscanify/blob/master/LICENSE"><img src="https://img.shields.io/github/license/ColonelParrot/jscanify.svg"></a> <a href="https://github.com/ColonelParrot/jscanify/blob/master/LICENSE"><img src="https://img.shields.io/github/license/ColonelParrot/jscanify.svg"></a>
<a href="https://GitHub.com/ColonelParrot/jscanify/releases/"><img src="https://img.shields.io/github/release/ColonelParrot/jscanify.svg"></a> <a href="https://GitHub.com/ColonelParrot/jscanify/releases/"><img src="https://img.shields.io/github/release/ColonelParrot/jscanify.svg"></a>
<a href="https://npmjs.com/package/jscanify"><img src="https://badgen.net/npm/v/jscanify"></a> <a href="https://npmjs.com/package/jscanify"><img src="https://badgen.net/npm/v/jscanify"></a>
@ -22,8 +26,8 @@ Available on <a href="https://www.npmjs.com/package/jscanify">npm</a> or via <a
- paper detection & highlighting - paper detection & highlighting
- paper scanning with distortion correction - paper scanning with distortion correction
| Image Highlighting | Scanned Result | | Image Highlighting | Scanned Result |
| ------------------------------------------------- | ----------------------------------------------- | | -------------------------------------------- | ------------------------------------------ |
| <img src="docs/images/highlight-paper1.png"> | <img src="docs/images/scanned-paper1.png"> | | <img src="docs/images/highlight-paper1.png"> | <img src="docs/images/scanned-paper1.png"> |
| <img src="docs/images/highlight-paper2.png"> | <img src="docs/images/scanned-paper2.png"> | | <img src="docs/images/highlight-paper2.png"> | <img src="docs/images/scanned-paper2.png"> |
@ -80,9 +84,10 @@ image.onload = function () {
The following code continuously reads from the user's camera and highlights the paper: The following code continuously reads from the user's camera and highlights the paper:
```html ```html
<video id="video"></video> <video id="video"></video> <canvas id="canvas"></canvas>
<canvas id="canvas"></canvas> <!-- original video --> <!-- original video -->
<canvas id="result"></canvas> <!-- highlighted video --> <canvas id="result"></canvas>
<!-- highlighted video -->
``` ```
```js ```js
@ -104,6 +109,8 @@ navigator.mediaDevices.getUserMedia({ video: true }).then((stream) => {
``` ```
To export the paper to a PDF, see [here](https://stackoverflow.com/questions/23681325/convert-canvas-to-pdf) To export the paper to a PDF, see [here](https://stackoverflow.com/questions/23681325/convert-canvas-to-pdf)
### Notes ### Notes
- for optimal paper detection, the paper should be placed on a flat surface with a solid background color - for optimal paper detection, the paper should be placed on a flat surface with a solid background color
- we recommend wrapping your code using `jscanify` in a window `load` event listener to ensure OpenCV is loaded - we recommend wrapping your code using `jscanify` in a window `load` event listener to ensure OpenCV is loaded