2.0.0-RC1

.build/pre-release.sh

@@ -1,13 +1,8 @@
 #!/usr/bin/env bash
 set -ex
 
-echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc
-npm whoami
-
-npm ci
 patchVersion=$(npm --no-git-tag version patch)
 nextVersion=${patchVersion}-next."$(date +%Y%m%d%H%M%S)"
 echo "${nextVersion:1}"
 
-npm version --no-git-tag -f "${nextVersion:1}"
-npm run publish-next
+npm version --no-git-tag -f "${nextVersion:1}"

.github/workflows/ci.yaml

@@ -43,7 +43,7 @@ jobs:
           npm run coverage:merge
           npm run coverage:merge-report
       - name: Send results to SonarCloud
-        uses: SonarSource/sonarcloud-github-action@v1.4
+        uses: SonarSource/sonarcloud-github-action@v1.6
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
@@ -53,11 +53,8 @@ jobs:
       - sonar
     strategy:
       matrix:
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        node: [ 12, 14, 16 ]
-        exclude:
-          - os: ubuntu-latest
-            node: 14
+        os: [ windows-latest, macos-latest ]
+        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
@@ -58,9 +58,21 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: 14
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install
+        run: npm ci
       - name: Install @nut-tree/libnut@next
         run: npm i @nut-tree/libnut@next
-      - name: Publish snapshot release
+      - name: Create snapshot release
         run: bash ./.build/pre-release.sh
+      - name: Publish snapshot release to npm
+        run: npm run publish-next
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - uses: actions/setup-node@v2
+        with:
+          registry-url: 'https://npm.pkg.github.com'
+      - name: Publish snapshot release to GPR
+        run: npm run publish-next
         env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.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
@@ -52,6 +52,7 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: 14
+          registry-url: 'https://registry.npmjs.org'
       - name: Install
         run: npm ci
       - name: Run typedoc
@@ -62,7 +63,14 @@ jobs:
           deploy_key: ${{ secrets.API_DOC_DEPLOY_KEY }}
           external_repository: nut-tree/apidoc
           publish_dir: ./docs
-      - name: Publish tagged release
-        uses: JS-DevTools/npm-publish@v1
+      - name: Publish tagged release to npm
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - uses: actions/setup-node@v2
         with:
-          token: ${{ secrets.NPM_TOKEN }}
+          registry-url: 'https://npm.pkg.github.com'
+      - name: Publish tagged release to GPR
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -5,23 +5,15 @@
 |Master |![Create tagged release](https://github.com/nut-tree/nut.js/workflows/Create%20tagged%20release/badge.svg)|
 |Develop|![Create snapshot release](https://github.com/nut-tree/nut.js/workflows/Create%20snapshot%20release/badge.svg)|
 
-![Supported node LTS versions](https://img.shields.io/badge/node%40lts-erbium%2C%20fermium-green)
-![Supported node versions](https://img.shields.io/badge/node-16.x.x-green)
-![Supported Electron versions](https://img.shields.io/badge/electron-8.x.x%20--%2013.x.x-green)
-
 [![SonarCloud badge](https://sonarcloud.io/api/project_badges/measure?project=nut-tree%3Anut.js&metric=alert_status)](https://sonarcloud.io/dashboard?id=nut-tree%3Anut.js)
 [![SonarCloud Coverage](https://sonarcloud.io/api/project_badges/measure?project=nut-tree%3Anut.js&metric=coverage)](https://sonarcloud.io/component_measures?id=nut-tree%3Anut.js&metric=coverage)
 
 [![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>
 
 # About
 
@@ -34,10 +26,30 @@ Native UI testing / automation with node.js
 It allows for native UI interactions via keyboard and / or mouse,
 but additionally gives you the possibility to navigate the screen based on image matching.
 
+# Sponsoring
+
+`nut.js` is developed with community in mind.
+
+A huge **"Thank you!"** goes out to all sponsors who make open source a bit more sustainable!
+
+[<img src="https://avatars.githubusercontent.com/u/17616211?v=4" width="75" alt="Reiss Cashmore" />](https://github.com/Reiss-Cashmore)
+[<img src="https://avatars.githubusercontent.com/u/1794527?v=4" width="75" alt="Chet Corcos" />](https://github.com/ccorcos)
+[<img src="https://avatars.githubusercontent.com/u/562800?v=4" width="75" alt="Stephan Petzl" />](https://github.com/stoefln)
+
+# Demo
+
+Check out this demo video to get a first impression of what nut.js is capable of.
+
+[![nut.js demo video](https://img.youtube.com/vi/MpIyUJnU_Bk/1.jpg)](https://www.youtube.com/watch?v=MpIyUJnU_Bk)
+
 # Examples
 
 [nut-tree/trailmix](https://github.com/nut-tree/trailmix) contains a set of ready to use examples which demo the usage ot nut.js.
 
+# API Docs
+
+nut.js provides [public API documentation](https://nut-tree.github.io/apidoc/) auto-generated by [TypeDoc](https://typedoc.org).
+
 # Discussion
 
 In [nut-tree/rfc](https://github.com/nut-tree/rfc) documents regarding larger design / implementation changes in nut.js are up for discussion.
@@ -59,7 +71,7 @@ It's work in progress and will undergo constant modification.
 ## Keyboard
 
 - [x] Support for standard US keyboard layout
-- [x] Support for German special characters
+- [x] Support for multimedia keys
 
 ## Mouse
 
@@ -77,8 +89,10 @@ It's work in progress and will undergo constant modification.
 
 ## Screen
 
-- [x] findOnScreen
-- [x] waitFor
+- [x] Find an image on screen
+- [x] Find all image occurrences on screen
+- [x] Wait for an image to appear on screen
+- [x] Retrieve RGBA color information on screen
 - [x] Hooks to trigger actions based on images
 - [x] Highlighting screen regions
 
@@ -201,96 +215,3 @@ will install the most recent development release of `nut.js`.
 
 **Attention**: While snapshot releases are great to work with upcoming features before a new stable release, it is still a snapshot release.
 Please bear in mind that things might change and / or break on snapshot releases, so it is not recommended using them in production.
-
-### Usage with Electron
-
-`nut.js` in combination with Electron requires bindings built for use with Electron.
-`nut.js` does provide such bindings and e.g. [electron-rebuild](https://www.npmjs.com/package/electron-rebuild) makes installation a breeze.
-
-Besides installing `nut.js` via
-
-```bash
-npm i @nut-tree/nut-js
-```
-
-or
-
-```bash
-yarn add @nut-tree/nut-js
-```
-
-we also install `electron-rebuild` as a `devDependency`:
-
-```bash
-npm i -D electron-rebuild
-```
-
-or 
-
-```bash
-yarn add -D electron-rebuild
-```
-
-Next, we add a `rebuild` script to our `package.json`:
-
-```json
-{
-    ...
-    "scripts": {
-        ...
-        "start": "electron app.js",
-        "rebuild": "electron-rebuild"
-    },
-    ...,
-}
-```
-
-Now all we have to do is run `npm run rebuild` and `electron-rebuild` will fetch the appropriate bindings for our Electron version.
-Currently `nut.js` provides bindings for all ABI version to work with Electron v4.x up to 8.x
-
-### Manual build
-
-As a fallback, `nut.js` is able to build all required dependencies by itself.
-To do so, some setup is required on the respective target platform.
-
-#### Windows
-
-In order to install `nut.js` on Windows, [Windows Build Tools](https://www.microsoft.com/en-us/download/details.aspx?id=48159) and [Python 2](https://www.python.org/downloads/windows/) are required.
-You can either set them up manually, or install them via npm:
-
-```bash
-npm install --global windows-build-tools
-```
-
-or
-
-```bash
-yarn global add windows-build-tools
-```
-
-#### macOS
-
-On macOS, Xcode command line tools are required.
-You can install them by running
-```bash
-xcode-select --install
-```
-
-#### Linux
-
-Depending on your distribution, Linux setups may differ.
-
-In general, `nut.js` requires
-
-- Python 2
-- g++
-- make
-- libXtst
-- libPng
-
-Installation on `*buntu` distributions:
-```bash
-sudo apt-get install build-essential python libxtst-dev libpng++-dev
-```
-
-Setups on other distributions might differ.