Merge pull request #123 from nut-tree/feature/87/api_docs

Feature/87/api docs

Author: s1hofmann

README.md

@@ -1,4 +1,4 @@
-# nut.js (Native UI Toolkit) [![Build Status](https://travis-ci.com/nut-tree/nut.js.svg?branch=master)](https://travis-ci.com/nut-tree/nut.js) [![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.js (Native UI Toolkit) [![Build Status](https://travis-ci.com/nut-tree/nut.js.svg?branch=master)](https://travis-ci.com/nut-tree/nut.js) [![Build status](https://ci.appveyor.com/api/projects/status/iohwxc5t46gcuvby/branch/master?svg=true)](https://ci.appveyor.com/project/s1hofmann/nut-js/branch/master) [![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">
 Native UI testing / automation with node.js
 </p>
@@ -21,7 +21,7 @@ but additionally gives you the possibility to navigate the screen based on image
 
 # Sample
 
-The following snippet shows a valid NUT example (on macOS)
+The following snippet shows a valid `nut.js` example (on macOS)
 
 ```js
 "use strict";
@@ -61,6 +61,7 @@ In order to use these pre-compiled bindings, certain runtime conditions have to
 ## 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
 
@@ -155,8 +156,74 @@ or
 yarn add @nut-tree/nut-js
 ```
 
-will install nut.js and its required dependencies.
+will install `nut.js` and its required dependencies.
 
+### Snapshot releases
+
+`nut.js` also provides snapshot releases which allows to test upcoming features.
+
+Running 
+
+```bash
+npm i @nut-tree/nut-js@next
+```
+
+or
+
+```bash
+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.
+
+### 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
 
 # Examples
 

docs/assets/css/main.css

@@ -102,7 +102,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3bcae92/lib/assert.class.ts#L5">assert.class.ts:5</a></li>
+									<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/assert.class.ts#L5">assert.class.ts:5</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -128,7 +128,7 @@ <h3>is<wbr>Visible</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3bcae92/lib/assert.class.ts#L8">assert.class.ts:8</a></li>
+									<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/assert.class.ts#L8">assert.class.ts:8</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -157,7 +157,7 @@ <h3>not<wbr>Visible</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3bcae92/lib/assert.class.ts#L25">assert.class.ts:25</a></li>
+									<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/assert.class.ts#L25">assert.class.ts:25</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>

docs/assets/images/icons.png

@@ -95,7 +95,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> compute</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3bcae92/lib/util/bresenham.class.ts#L4">util/bresenham.class.ts:4</a></li>
+									<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/util/bresenham.class.ts#L4">util/bresenham.class.ts:4</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>