@udarrr/template-matcher - npm Package Compare versions

Comparing version 2.1.2 to 2.1.3

package.json

 {
   "name": "@udarrr/template-matcher",
-  "version": "2.1.2",
+  "version": "2.1.3",
   "main": "dist/index",
@@ -5,0 +5,0 @@ "typings": "dist/index",

README.md

@@ -1,2 +0,2 @@
-# OpenCV 4.1.1 Template Matching Image Finder 
+# OpenCV 4.1.1 Template Matching Image Finder
 
@@ -7,11 +7,6 @@ ![Tested](https://github.com/udarrr/TemplateMatcher/workflows/Tests/badge.svg)
 
-### It's plugin for [nutjs project](https://www.npmjs.com/package/@nut-tree/nut-js) or standalone with some features like
+## It's either standalone or plugin for [nutjs project](https://www.npmjs.com/package/@nut-tree/nut-js)
 
-- incresed accuracy (x10)
-- incresed perfomance (~x2)
-- added some customOptions for arguments `params?: OptionalSearchParameters` in [nutjs](https://github.com/nut-tree/nut.js/blob/develop/lib/optionalsearchparameters.class.ts) !not implemented in nutjs yet, but available in standalone
-- added standalone
+### Installation for standalone
 
-#### Installation for nutjs
-
 ```nodejs
@@ -21,14 +16,2 @@ npm i @udarrr/template-matcher
 
-and then just use it in your project once
-
-```javascript
-import "@udarrr/template-matcher"` or `require("@udarrr/template-matcher")
-```
-
-#### Installation for standalone
-
-```nodejs
-npm i @udarrr/template-matcher
-```
-
 and connect finder to your project
@@ -47,7 +30,22 @@
 
-#### Options
+### Installation for nutjs
 
+```nodejs
+npm i @udarrr/template-matcher
+```
+
+and then just use it in your project once
+
 ```javascript
-//nutjs options 
+import "@udarrr/template-matcher"` or `require("@udarrr/template-matcher")
+```
+
+### Options
+
+#### Standalone
+
+```typescript
 {
+    haystack?: string | Image,
+    needle: string | Image,
     confidence?: number,
@@ -64,7 +62,7 @@ searchMultipleScales?: boolean,
 
-```typescript
-//standalone 
+#### Nutjs
+
+```javascript
+//
 {
-    haystack?: string | Image,
-    needle: string | Image,
     confidence?: number,
@@ -81,9 +79,13 @@ searchMultipleScales?: boolean,
 
-```javascript
-// methodType: "TM_CCOEFF" | "TM_CCOEFF_NORMED" | "TM_CCORR" | "TM_CCORR_NORMED" | "TM_SQDIFF" | "TM_SQDIFF_NORMED" by default "TM_CCOEFF_NORMED"
-// scaleSteps:  [0.9]; by default  [1, 0.9, 0.8, 0.7, 0.6, 0.5]
-// debug: true | false by default false
+#### Values by default
 
-// for "TM_SQDIFF" | "TM_SQDIFF_NORMED" confidence by default 0.98
-// for "TM_CCOEFF" | "TM_CCOEFF_NORMED" | "TM_CCORR" | "TM_CCORR_NORMED" by default 0.8
+```nodejs
+methodType: "TM_CCOEFF" | "TM_CCOEFF_NORMED" | "TM_CCORR" | "TM_CCORR_NORMED" | "TM_SQDIFF" | "TM_SQDIFF_NORMED" by default "TM_CCOEFF_NORMED"
+scaleSteps:  [0.9]; by default  [1, 0.9, 0.8, 0.7, 0.6, 0.5]
+debug: true | false by default false
+confidence: for "TM_SQDIFF" | "TM_SQDIFF_NORMED" confidence by default 0.98 for "TM_CCOEFF" | "TM_CCOEFF_NORMED" | "TM_CCORR" | "TM_CCORR_NORMED" by default 0.8
 ```
+
+#### Disclaimer for nutjs v3
+
+In case using the package with [nutjs](https://github.com/nut-tree/nut.js/blob/develop/lib/optionalsearchparameters.class.ts) v3 or above please use precise 2.0.1 version of the package

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

87

increased by2.35%

Worsened metrics

Total package byte prevSize

71783

decreased by-0.13%

No dependency changes