Skip to content

Commit 67f8687

Browse files
authored
Release/v2.0.0 rc1 (#345)
* Updated readme * RC1 * Update @nut-tree/libnut to 2.1.3 * Center image in readme again * Fixed typedoc config
1 parent be5ea87 commit 67f8687

File tree

4 files changed

+125
-251
lines changed

4 files changed

+125
-251
lines changed

Diff for: README.md

+6-115
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@
55
|Master |![Create tagged release](https://github.com/nut-tree/nut.js/workflows/Create%20tagged%20release/badge.svg)|
66
|Develop|![Create snapshot release](https://github.com/nut-tree/nut.js/workflows/Create%20snapshot%20release/badge.svg)|
77

8-
![Supported node LTS versions](https://img.shields.io/badge/node%40lts-erbium%2C%20fermium-green)
9-
![Supported node versions](https://img.shields.io/badge/node-16.x.x-green)
10-
![Supported Electron versions](https://img.shields.io/badge/electron-8.x.x%20--%2013.x.x-green)
11-
128
[![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)
139
[![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)
1410

@@ -19,23 +15,9 @@ Native UI testing / automation with node.js
1915
</p>
2016
<br/>
2117

22-
## Attention
23-
24-
nut.js is currently under heavy development towards a new major release!
25-
26-
Be prepared for awesome new features like
27-
28-
- slimmed down base installation
29-
- a plugin system
30-
- Apple Silicon compatibility
31-
32-
and of course
33-
34-
- lots of bugs fixed
35-
3618
# About
3719

38-
<p style="text-align: center">
20+
<p align="center">
3921
<img src="https://github.com/nut-tree/nut.js/raw/master/.gfx/nut.png" alt="logo" width="200"/>
4022
</p>
4123

@@ -89,7 +71,7 @@ It's work in progress and will undergo constant modification.
8971
## Keyboard
9072

9173
- [x] Support for standard US keyboard layout
92-
- [x] Support for German special characters
74+
- [x] Support for multimedia keys
9375

9476
## Mouse
9577

@@ -107,8 +89,10 @@ It's work in progress and will undergo constant modification.
10789

10890
## Screen
10991

110-
- [x] findOnScreen
111-
- [x] waitFor
92+
- [x] Find an image on screen
93+
- [x] Find all image occurrences on screen
94+
- [x] Wait for an image to appear on screen
95+
- [x] Retrieve RGBA color information on screen
11296
- [x] Hooks to trigger actions based on images
11397
- [x] Highlighting screen regions
11498

@@ -231,96 +215,3 @@ will install the most recent development release of `nut.js`.
231215

232216
**Attention**: While snapshot releases are great to work with upcoming features before a new stable release, it is still a snapshot release.
233217
Please bear in mind that things might change and / or break on snapshot releases, so it is not recommended using them in production.
234-
235-
### Usage with Electron
236-
237-
`nut.js` in combination with Electron requires bindings built for use with Electron.
238-
`nut.js` does provide such bindings and e.g. [electron-rebuild](https://www.npmjs.com/package/electron-rebuild) makes installation a breeze.
239-
240-
Besides installing `nut.js` via
241-
242-
```bash
243-
npm i @nut-tree/nut-js
244-
```
245-
246-
or
247-
248-
```bash
249-
yarn add @nut-tree/nut-js
250-
```
251-
252-
we also install `electron-rebuild` as a `devDependency`:
253-
254-
```bash
255-
npm i -D electron-rebuild
256-
```
257-
258-
or
259-
260-
```bash
261-
yarn add -D electron-rebuild
262-
```
263-
264-
Next, we add a `rebuild` script to our `package.json`:
265-
266-
```json
267-
{
268-
...
269-
"scripts": {
270-
...
271-
"start": "electron app.js",
272-
"rebuild": "electron-rebuild"
273-
},
274-
...,
275-
}
276-
```
277-
278-
Now all we have to do is run `npm run rebuild` and `electron-rebuild` will fetch the appropriate bindings for our Electron version.
279-
Currently `nut.js` provides bindings for all ABI version to work with Electron v4.x up to 8.x
280-
281-
### Manual build
282-
283-
As a fallback, `nut.js` is able to build all required dependencies by itself.
284-
To do so, some setup is required on the respective target platform.
285-
286-
#### Windows
287-
288-
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.
289-
You can either set them up manually, or install them via npm:
290-
291-
```bash
292-
npm install --global windows-build-tools
293-
```
294-
295-
or
296-
297-
```bash
298-
yarn global add windows-build-tools
299-
```
300-
301-
#### macOS
302-
303-
On macOS, Xcode command line tools are required.
304-
You can install them by running
305-
```bash
306-
xcode-select --install
307-
```
308-
309-
#### Linux
310-
311-
Depending on your distribution, Linux setups may differ.
312-
313-
In general, `nut.js` requires
314-
315-
- Python 2
316-
- g++
317-
- make
318-
- libXtst
319-
- libPng
320-
321-
Installation on `*buntu` distributions:
322-
```bash
323-
sudo apt-get install build-essential python libxtst-dev libpng++-dev
324-
```
325-
326-
Setups on other distributions might differ.

0 commit comments

Comments
 (0)