Update readme and changelog

Author: s1hofmann

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## 4.2.0
+
+- Feature: Extend `Window` class with `minimize` and `restore` methods
+
 ## 4.1.0
 
 - Enhancement: Extend `WindowProviderInterface` with `minimizeWindow` and `restoreWindow` functions

README.md

@@ -1,16 +1,13 @@
 # nut.js (Native UI Toolkit)
 
 |         |                                                 GitHub Actions                                                 |
-| :-----: | :------------------------------------------------------------------------------------------------------------: |
+|:-------:|:--------------------------------------------------------------------------------------------------------------:|
 | 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) |
 
 [![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)
-[![@nut-tree/nut-js](https://snyk.io/advisor/npm-package/@nut-tree/nut-js/badge.svg)](https://snyk.io/advisor/npm-package/@nut-tree/nut-js)
-
 <a href="https://console.dev" title="Visit Console - the best tools for developers"><img src="https://console.dev/img/badges/1.0/svg/console-badge-logo-dark.svg" alt="Console - Developer Tool of the Week" /></a>
 
 <p align="center">
@@ -34,7 +31,16 @@ for detailed documentation and tutorials
 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
+# The Price of Open Source
+
+If you came here after I removed public packages from npm as announced
+in ['the blog post'](https://nutjs.dev/blog/i-give-up), please be aware that
+
+- nut.js is still open source (you are right here, aren't you?)
+- nut.js is still free to use, you'll just have to build it from sources
+- nut.js is still maintained and developed further
+- nut.js does not force anyone to pay anything, because you can even build every single plugin yourself. It's just
+  interfaces to implement
 
 `nut.js` is developed with community in mind.
 
@@ -48,11 +54,13 @@ Check out this demo video to get a first impression of what nut.js is capable of
 
 # Tutorials
 
-Please consult the project website at [nutjs.dev](https://nutjs.dev/tutorials/first_steps#prerequisites) for in-depth tutorials
+Please consult the project website at [nutjs.dev](https://nutjs.dev/tutorials/first_steps#prerequisites) for in-depth
+tutorials
 
 # API Docs
 
-nut.js provides [public API documentation](https://nut-tree.github.io/apidoc/) auto-generated by [TypeDoc](https://typedoc.org).
+nut.js provides [public API documentation](https://nut-tree.github.io/apidoc/) auto-generated
+by [TypeDoc](https://typedoc.org).
 
 # Community
 
@@ -89,13 +97,19 @@ It's work in progress and will undergo constant modification.
 - [x] Focus window
 - [x] Resize window
 - [x] Reposition window
+- [x] Minimize a window (\*)
+- [x] Restore a window (\*)
+- [x] Inspect GUI elements of a window (\*)
+- [x] Search for specific GUI elements of a window (\*)
 
 ## Screen
 
 - [x] Retrieve RGBA color information on screen
 - [x] Highlighting screen regions
-- [x] Find a single or multiple occurrences of 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] 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] Find a single or multiple occurrences of 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] 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] Find a single or multiple occurrences of text on screen (\*)
 - [x] Wait for a piece of text to appear on screen (\*)
 - [x] Find a single or multiple windows on screen (\*)
@@ -169,7 +183,10 @@ This section lists runtime requirements for `nut.js` on the respective target pl
 
 #### Windows
 
-In case you're running Windows 10 N and want to use [ImageFinder plugins](https://nutjs.dev/plugins/imagefinder), please make sure to have the [Media Feature Pack](https://support.microsoft.com/en-us/topic/media-feature-pack-for-windows-10-n-may-2020-ebbdf559-b84c-0fc2-bd51-e23c9f6a4439) installed.
+In case you're running Windows 10 N and want to use [ImageFinder plugins](https://nutjs.dev/plugins/imagefinder), please
+make sure to have
+the [Media Feature Pack](https://support.microsoft.com/en-us/topic/media-feature-pack-for-windows-10-n-may-2020-ebbdf559-b84c-0fc2-bd51-e23c9f6a4439)
+installed.
 
 #### macOS
 
@@ -182,7 +199,8 @@ xcode-select --install
 
 **Permissions**:
 
-nut.js requires the executing application, e.g. your terminal, to be given both `Accessibility` and `Screen Recording` permissions.
+nut.js requires the executing application, e.g. your terminal, to be given both `Accessibility` and `Screen Recording`
+permissions.
 
 Starting with release `2.3.0`, nut.js will check for and request these permissions automatically:
 
@@ -192,8 +210,12 @@ Starting with release `2.3.0`, nut.js will check for and request these permissio
 
 It will also give you a subtle hint in case permissions are lacking:
 
-- Accessibility: `##### WARNING! The application running this script is not a trusted process! Please visit https://github.com/nut-tree/nut.js#macos #####`
-- Screen Recording: `##### WARNING! The application running this script is not allowed to capture screen content! Please visit https://github.com/nut-tree/nut.js#macos #####`
+-
+
+Accessibility: `##### WARNING! The application running this script is not a trusted process! Please visit https://github.com/nut-tree/nut.js#macos #####`
+
+- Screen
+  Recording: `##### WARNING! The application running this script is not allowed to capture screen content! Please visit https://github.com/nut-tree/nut.js#macos #####`
 
 **Attention**:
 
@@ -234,7 +256,27 @@ On e.g. Ubuntu you can switch to XWayland on your login screen as a workaround.
 
 ## Install `nut.js`
 
-Running
+### Open Source
+
+The core functionality of `nut.js` is open source and available on GitHub.
+
+To build nut.js from source you'll have to build native dependencies first.
+
+- Start with [@nut-tree/libnut-core](https://github.com/nut-tree/libnut-core)
+    - A build pipeline can be found in the respective repository
+- Update dependencies in `nut.js` to point to your local build of `libnut-core`
+    - A build pipeline can be found in the respective repository
+
+### Pre-built packages
+
+Pre-built packages are available for subscription plans.
+
+Check out the [pricing page](https://nutjs.dev/pricing/pricing) for more information.
+
+Once you subscribed to a plan, you'll receive a token which you can use to install the respective
+package, [check out the registry access tutorial for reference](https://nutjs.dev/tutorials/registry-access).
+
+With everything set up, running
 
 ```bash
 npm i @nut-tree/nut-js
@@ -266,5 +308,7 @@ yarn add @nut-tree/nut-js@next
 
 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.
+**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.