@techstark/opencv-js 4.11.0-release.1 → 4.12.0-release.1

package/README.md

@@ -1,36 +1,37 @@
 # opencv-js
 
-OpenCV JavaScript version (NPM package) for node.js or browser. Get started guide [OpenCV.js Tutorials](https://docs.opencv.org/4.11.0/#:~:text=OpenCV%2DPython%20Tutorials-,OpenCV.js%20Tutorials,-Tutorials%20for%20contrib).
+OpenCV JavaScript version (NPM package) for node.js or browser. Get started guide [OpenCV.js Tutorials](https://docs.opencv.org/4.12.0/#:~:text=OpenCV%2DPython%20Tutorials-,OpenCV.js%20Tutorials,-Tutorials%20for%20contrib).
 
-The file `opencv.js` was downloaded from https://docs.opencv.org/4.11.0/opencv.js
+The file `opencv.js` was downloaded from https://docs.opencv.org/4.12.0/opencv.js
 
 TypeScript is supported (thanks to `mirada`).
 
 # Basic Usage
 
-## >=4.11
-
 ```js
-import cvReadyPromise from "@techstark/opencv-js";
+import cvModule from "@techstark/opencv-js";
+
+async function getOpenCv() {
+  let cv;
+  if (cvModule instanceof Promise) {
+    cv = await cvModule;
+  } else {
+    await new Promise((resolve) => {
+      cvModule.onRuntimeInitialized = () => resolve();
+    });
+    cv = cvModule;
+  }
+  return { cv };
+}
 
 async function main() {
-  const cv = await cvReadyPromise;
+  const { cv } = await getOpenCv();
   console.log("OpenCV.js is ready!");
   // You can now use OpenCV functions here
   console.log(cv.getBuildInformation());
 }
-```
-
-## <=4.10
 
-```js
-import cv from "@techstark/opencv-js";
-
-cv.onRuntimeInitialized = () => {
-  console.log("OpenCV.js is ready!");
-  // You can now use OpenCV functions here
-  console.log(cv.getBuildInformation());
-};
+main();
 ```
 
 # Code Examples