Release/v2.0.0 (#353)

* Updated readme

* Fixed alignment of main heading

* Updated changelog for 2.0.0

* Version bump to 2.0.0

* Release v2.0.0

Author: s1hofmann

CHANGELOG.md

@@ -2,6 +2,34 @@
 
 All notable changes to this project will be documented in this file.
 
+## 2.0.0
+- Feature: Apple Silicon [(libnut#49)](https://github.com/nut-tree/libnut/issues/49)
+- Enhancement: Enable warning message for missing accessibility permissions on macOS [(#354)](https://github.com/nut-tree/nut.js/issues/354)
+- Enhancement: Add runtime typechecks for `screen.find` etc. [(#351)](https://github.com/nut-tree/nut.js/issues/351)
+- Bugfix: Fix Windows scaling issue [(#349)](https://github.com/nut-tree/nut.js/issues/349)
+- Maintenance: Refine types [(#340)](https://github.com/nut-tree/nut.js/issues/340)
+- Maintenance: Cleanup deprecated code [(#341)](https://github.com/nut-tree/nut.js/issues/341)
+- Enhancement: Support for mouse capturing games [(#168)](https://github.com/nut-tree/nut.js/issues/168)
+- Feature: Provide functions to convert images between BGR and RGB color mode [(#336)](https://github.com/nut-tree/nut.js/issues/336)
+- Feature: Audio keys support [(#233)](https://github.com/nut-tree/nut.js/issues/233)
+- Enhancement: Configurable interval for `waitFor` [(#312)](https://github.com/nut-tree/nut.js/issues/312)
+- Bugfix: Apply pixel density scaling on `colorAt` [(#327)](https://github.com/nut-tree/nut.js/issues/327)
+- Enhancement: Change `find` signature to only work on `Image` instances [(#329)](https://github.com/nut-tree/nut.js/issues/329)
+- Enhancement: Adjust `assert` class to new `Screen#find` parameter types [(#324)](https://github.com/nut-tree/nut.js/issues/324)
+- Feature: Get screen pixel color [(#259)](https://github.com/nut-tree/nut.js/issues/259)
+- Feature: Add `Screen#findAll` to enable matching multiple template occurrences [(#320)](https://github.com/nut-tree/nut.js/issues/321)
+- Enhancement: Make Screen#find accept `Promise<Image>` [(#320)](https://github.com/nut-tree/nut.js/issues/320)
+- Enhancement: Accepting a Buffer with image data for `Screen#find` [(#204)](https://github.com/nut-tree/nut.js/issues/204)
+- Enhancement: Get rid of adapter layer in favour of providerRegistry [(#310)](https://github.com/nut-tree/nut.js/issues/310)
+- Feature: Provide a default implementation for `ImageReader` and `ImageWriter` [(#307)](https://github.com/nut-tree/nut.js/issues/307)
+- Feature: Define interface for mouse movement type [(#130)](https://github.com/nut-tree/nut.js/issues/130)
+- Feature: Separate image matching code [(#279)](https://github.com/nut-tree/nut.js/issues/279)
+- Enhancement: Export `FileType` [(#301)](https://github.com/nut-tree/nut.js/issues/301)
+- Enhancement: Export `ImageWriterParameters` [(#296)](https://github.com/nut-tree/nut.js/issues/296)
+- Enhancement: Export provider interfaces [(#294)](https://github.com/nut-tree/nut.js/issues/294)
+- Feature: Introduce a registry for providers [(#292)](https://github.com/nut-tree/nut.js/issues/292)
+- Feature: Add methods to grab the current screen content as Buffer [(#278)](https://github.com/nut-tree/nut.js/issues/278)
+
 ## 1.7.0
 - Enhancement: Trigger snapshot releases [(#234)](https://github.com/nut-tree/nut.js/issues/234)
 - Feature: Cancel screen.waitFor if needed [(#241)](https://github.com/nut-tree/nut.js/issues/241)

README.md

@@ -10,8 +10,10 @@
 
 [![Downloads per month](https://img.shields.io/npm/dm/@nut-tree/nut-js)](https://www.npmjs.com/package/@nut-tree/nut-js)
 
-<p style="text-align: center">
-Native UI testing / automation with node.js
+<h1 align="center"><a href="https://nutjs.dev">nutjs.dev</a></h1>
+
+<p align="center">
+Native UI testing / automation with Node.js
 </p>
 <br/>
 
@@ -42,6 +44,10 @@ 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)
 
+# Tutorials
+
+Please consult the project website at [nutjs.dev](https://nutjs.dev/docs/tutorial-first_steps/prerequisits) for in-depth tutorials
+
 # 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.
@@ -50,10 +56,6 @@ Check out this demo video to get a first impression of what nut.js is capable of
 
 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.
-
 # Community
 
 Feel free to join our [Discord community](https://discord.gg/sJkN7789XR)
@@ -89,11 +91,11 @@ It's work in progress and will undergo constant modification.
 
 ## Screen
 
-- [x] Find an image on screen
+- [x] Find an image on screen (requires an additional provider package like e.g. [nut-tree/template-matcher](https://www.npmjs.com/package/@nut-tree/template-matcher))
 - [x] Find all image occurrences on screen
-- [x] Wait for an image to appear on screen
+- [x] Wait for an image to appear on screen (requires an additional provider package like e.g. [nut-tree/template-matcher](https://www.npmjs.com/package/@nut-tree/template-matcher))
 - [x] Retrieve RGBA color information on screen
-- [x] Hooks to trigger actions based on images
+- [x] Hooks to trigger actions based on images (requires an additional provider package like e.g. [nut-tree/template-matcher](https://www.npmjs.com/package/@nut-tree/template-matcher))
 - [x] Highlighting screen regions
 
 ## Integration
@@ -103,12 +105,12 @@ It's work in progress and will undergo constant modification.
 
 # Sample
 
-The following snippet shows a valid `nut.js` example (on macOS)
+The following snippet shows a valid `nut.js` example:
 
 ```js
 "use strict";
 
-const { keyboard, Key, mouse, left, right, up, down, screen } = require("@nut-tree/nut-js");
+const { mouse, left, right, up, down, straightTo, centerOf, Region} = require("@nut-tree/nut-js");
 
 const square = async () => {
   await mouse.move(right(500));
@@ -117,30 +119,23 @@ const square = async () => {
   await mouse.move(up(500));
 };
 
-const openSpotlight = async () => {
-  await keyboard.pressKey(Key.LeftSuper);
-  await keyboard.pressKey(Key.Space);
-  await keyboard.releaseKey(Key.Space);
-  await keyboard.releaseKey(Key.LeftSuper);
-};
-
 (async () => {
     await square();
-    await openSpotlight();
-    await keyboard.type("calculator");
-    await keyboard.type(Key.Return);
+    await mouse.move(
+        straightTo(
+            centerOf(
+                new Region(100, 100, 200, 300)
+            )
+        )
+    );
 })();
 ```
 
 # Installation
 
-`nut.js` comes with a pre-built version of OpenCV for your respective target platform.
-In order to use these pre-compiled bindings, certain runtime conditions have to be met.
-
 ## Prerequisites
 
 This section lists runtime requirements for `nut.js` on the respective target platform.
-`nut.js` is built and tested against node 10 and later as well as Electron 4 and later, so in order to use `nut.js` please make sure to use one of these versions.
 
 #### Windows
 

package-lock.json

@@ -1,13 +1,13 @@
 {
   "name": "@nut-tree/nut-js",
-  "version": "2.0.0-RC1",
+  "version": "2.0.0",
   "license": "Apache-2.0",
   "main": "dist/index",
   "typings": "dist/index",
   "description": "Native system automation for node.js",
   "author": {
     "name": "Simon Hofmann",
-    "email": "dev@simon-hofmann.org",
+    "email": "kontakt@s1h.org",
     "url": "https://s1h.org"
   },
   "repository": {