Skip to content

Commit 5b982a8

Browse files
committed
(#87) Updated readme to include snapshot release info
1 parent aaefd8d commit 5b982a8

File tree

1 file changed

+28
-3
lines changed

1 file changed

+28
-3
lines changed

Diff for: README.md

+28-3
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ but additionally gives you the possibility to navigate the screen based on image
2121

2222
# Sample
2323

24-
The following snippet shows a valid NUT example (on macOS)
24+
The following snippet shows a valid `nut.js` example (on macOS)
2525

2626
```js
2727
"use strict";
@@ -61,6 +61,7 @@ In order to use these pre-compiled bindings, certain runtime conditions have to
6161
## Prerequisites
6262

6363
This section lists runtime requirements for `nut.js` on the respective target platform.
64+
`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.
6465

6566
#### Windows
6667

@@ -155,7 +156,28 @@ or
155156
yarn add @nut-tree/nut-js
156157
```
157158

158-
will install nut.js and its required dependencies.
159+
will install `nut.js` and its required dependencies.
160+
161+
### Snapshot releases
162+
163+
`nut.js` also provides snapshot releases which allows to test upcoming features.
164+
165+
Running
166+
167+
```bash
168+
npm i @nut-tree/nut-js@next
169+
```
170+
171+
or
172+
173+
```bash
174+
yarn add @nut-tree/nut-js@next
175+
```
176+
177+
will install the most recent development release of `nut.js`.
178+
179+
**Attention**: While snapshot releases are great to work with upcoming features before a new stable release, it is still a snapshot release.
180+
Please bear in mind that things might change and / or break on snapshot releases, so it is not recommended using them in production.
159181

160182
### Usage with Electron
161183

@@ -190,10 +212,13 @@ Next, we add a `rebuild` script to our `package.json`:
190212

191213
```json
192214
{
215+
...
193216
"scripts": {
217+
...
194218
"start": "electron app.js",
195219
"rebuild": "electron-rebuild"
196-
}
220+
},
221+
...,
197222
}
198223
```
199224

0 commit comments

Comments
 (0)