From 4c8ad93057241b78d341aeb3152552a1a0cb50f2 Mon Sep 17 00:00:00 2001
From: ColonelParrot <65585002+ColonelParrot@users.noreply.github.com>
Date: Thu, 13 Apr 2023 16:27:45 -0400
Subject: [PATCH] Add README.md

---
 README.md | 95 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 95 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d1fdaca
--- /dev/null
+++ b/README.md
@@ -0,0 +1,95 @@
+<p align="center">
+    <img src="docs/images/logo-full.png" height="100">
+</p>
+
+<p align="center">
+Open-source pure Javascript implemented mobile document scanner. Powered with <a href="https://docs.opencv.org/3.4/d5/d10/tutorial_js_root.html">opencv.js</a><br/><br/>
+Available on <a href="https://www.npmjs.com/package/jscanify">npm</a> or via cdn
+</p>
+
+**Features**:
+
+- paper detection & highlighting
+- paper scanning with distortion correction
+
+| Image Highlighting                                | Scanned Result                                  |
+| ------------------------------------------------- | ----------------------------------------------- |
+| <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"> |
+
+## Quickstart
+
+### Import
+
+npm:
+
+```js
+$ npm i jscanify
+import jscanify from 'jscanify'
+```
+
+cdn:
+
+```html
+<script src="https://docs.opencv.org/4.7.0/opencv.js" async></script>
+<!-- warning: loading OpenCV can take some time. Load asynchronously -->
+<script src="https://cdn.jsdelivr.net/gh/ColonelParrot/jscanify@master/src/jscanify.min.js"></script>
+```
+
+### Highlight Paper in Image
+
+```html
+<img src="/path/to/your/image.png" id="image" />
+```
+
+```js
+const scanner = new jscanify();
+image.onload = function () {
+  const highlightedCanvas = scanner.highlightPaper(image);
+  document.body.appendChild(highlightedCanvas);
+};
+```
+
+### Extract Paper
+
+```js
+const scanner = new jscanify();
+const paperWidth = 500;
+const paperHeight = 1000;
+image.onload = function () {
+  scanner.extractPaper(image, paperWidth, paperHeight, (resultCanvas) => {
+    document.body.appendChild(resultCanvas);
+  });
+};
+```
+
+### Highlighting Paper in User Camera
+
+The following code continuously reads from the user's camera and highlights the paper:
+
+```html
+<video id="video"></video>
+<canvas id="canvas"></canvas>  <!-- original video -->
+<canvas id="result"></canvas>  <!-- highlighted video -->
+```
+
+```js
+const scanner = new jscanify();
+const canvasCtx = canvas.getContext("2d");
+const resultCtx = result.getContext("2d");
+navigator.mediaDevices.getUserMedia({ video: true }).then((stream) => {
+  video.srcObject = stream;
+  video.onloadedmetadata = () => {
+    video.play();
+
+    setInterval(() => {
+      canvasCtx.drawImage(video, 0, 0);
+      const resultCanvas = scanner.highlightPaper(canvas);
+      resultCtx.drawImage(resultCanvas, 0, 0);
+    }, 10);
+  };
+});
+```
+### Notes
+- 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
\ No newline at end of file