Update README and docstrings

Author: s1hofmann

.github/workflows/ci.yaml

@@ -54,10 +54,7 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest, windows-latest, macos-latest ]
-        node: [ 12, 14, 16 ]
-        exclude:
-          - os: ubuntu-latest
-            node: 14
+        node: [ 14 ]
     runs-on: ${{matrix.os}}
     steps:
       - name: Set up Git repository

.github/workflows/snapshot_release.yaml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest, windows-latest, macos-latest ]
-        node: [ 12, 14, 16 ]
+        node: [ 14 ]
     runs-on: ${{matrix.os}}
     steps:
       - name: Set up Git repository

.github/workflows/tagged_release.yaml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest, windows-latest, macos-latest ]
-        node: [ 12, 14, 16 ]
+        node: [ 14 ]
     runs-on: ${{matrix.os}}
     steps:
       - name: Set up Git repository

README.md

@@ -14,18 +14,28 @@
 
 [![Downloads per month](https://img.shields.io/npm/dm/@nut-tree/nut-js)](https://www.npmjs.com/package/@nut-tree/nut-js)
 
-<p align="center">
+<p style="text-align: center">
 Native UI testing / automation with node.js
 </p>
 <br/>
-<p align="center">
-	<a target="_blank" href="https://github.com/justadudewhohacks/opencv4nodejs">
-		<img src="https://img.shields.io/badge/Built_with-opencv4nodejs-C86414.svg?style=flat-square" alt="Built with opencv4nodejs" /></a>
-</p>
+
+## Attention
+
+nut.js is currently under heavy development towards a new major release!
+
+Be prepared for awesome new features like
+
+- slimmed down base installation
+- a plugin system
+- Apple Silicon compatibility
+
+and of course
+
+- lots of bugs fixed
 
 # About
 
-<p align="center">
+<p style="text-align: center">
     <img src="https://github.com/nut-tree/nut.js/raw/master/.gfx/nut.png" alt="logo" width="200"/>
 </p>
 

lib/provider/image-finder.interface.ts

@@ -2,8 +2,7 @@ import { MatchRequest } from "../match-request.class";
 import { MatchResult } from "../match-result.class";
 
 /**
- * A Finder should provide an abstraction layer to perform
- * image processing and matching via a 3rd part library
+ * An ImageFinder should provide an abstraction layer to perform image matching
  *
  * @interface ImageFinderInterface
  */
@@ -12,8 +11,8 @@ export interface ImageFinderInterface {
    * findMatch should provide an abstraction to search for an image needle
    * in another image haystack
    *
-   * @param {MatchRequest} matchRequest A matchrequest containing needed matching data
-   * @returns {Promise<MatchResult>} A matchresult containing the match probability and location
+   * @param {MatchRequest} matchRequest A {@link MatchRequest} containing needed matching data
+   * @returns {Promise<MatchResult>} A {@link MatchResult} holding the match probability and location
    * @memberof ImageFinderInterface
    */
   findMatch(matchRequest: MatchRequest): Promise<MatchResult>;
@@ -23,7 +22,7 @@ export interface ImageFinderInterface {
    * in another image haystack
    *
    * @param {MatchRequest} matchRequest A matchrequest containing needed matching data
-   * @returns {Promise<MatchResult[]>} A list of matchresults containing the match probability and location
+   * @returns {Promise<MatchResult[]>} A list of {@link MatchResult}s holding the match probability and location
    * @memberof ImageFinderInterface
    */
   findMatches(matchRequest: MatchRequest): Promise<MatchResult[]>;

lib/provider/image-processor.interface.ts

@@ -2,6 +2,18 @@ import {Point} from "../point.class";
 import {RGBA} from "../rgba.class";
 import {Image} from "../image.class";
 
+/**
+ * An ImageProcessor should provide an abstraction layer to perform
+ * image processing via a 3rd part library
+ *
+ * @interface ImageFinderInterface
+ */
 export interface ImageProcessor {
+
+    /**
+     * {@link colorAt} returns a pixels {@link RGBA} value
+     * @param image The {@link Image} to query color information from
+     * @param location The {@link Point} where to query color information
+     */
     colorAt(image: Image | Promise<Image>, location: Point | Promise<Point>): Promise<RGBA>;
 }