Skip to content

Commit 187318e

Browse files
authored
doc: Removed references to Node.js lower than 10.x. (#709)
* Removed references to Node.js lower than 10.x.
1 parent 9c9accf commit 187318e

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ It is important to remember that *other* Node.js interfaces such as
2121
`libuv` (included in a project via `#include <uv.h>`) are not ABI-stable across
2222
Node.js major versions. Thus, an addon must use N-API and/or `node-addon-api`
2323
exclusively and build against a version of Node.js that includes an
24-
implementation of N-API (meaning a version of Node.js newer than 6.14.2) in
24+
implementation of N-API (meaning an active LTS version of Node.js) in
2525
order to benefit from ABI stability across Node.js major versions. Node.js
2626
provides an [ABI stability guide][] containing a detailed explanation of ABI
2727
stability in general, and the N-API ABI stability guarantee in particular.
@@ -47,14 +47,21 @@ to ideas specified in the **ECMA262 Language Specification**.
4747
- **[Contributors](#contributors)**
4848
- **[License](#license)**
4949

50-
## **Current version: 2.0.0**
50+
## **Current version: 3.0.0**
5151

5252
(See [CHANGELOG.md](CHANGELOG.md) for complete Changelog)
5353

5454
[![NPM](https://nodei.co/npm/node-addon-api.png?downloads=true&downloadRank=true)](https://nodei.co/npm/node-addon-api/) [![NPM](https://nodei.co/npm-dl/node-addon-api.png?months=6&height=1)](https://nodei.co/npm/node-addon-api/)
5555

5656
<a name="setup"></a>
5757

58+
node-addon-api is based on [N-API](https://nodejs.org/api/n-api.html) and supports using different N-API versions.
59+
This allows addons built with it to run with Node.js versions which support the targeted N-API version.
60+
**However** the node-addon-api support model is to support only the active LTS Node.js versions. This means that
61+
every year there will be a new major which drops support for the Node.js LTS version which has gone out of service.
62+
63+
The oldest Node.js version supported by the current version of node-addon-api is Node.js 10.x.
64+
5865
## Setup
5966
- [Installation and usage](doc/setup.md)
6067
- [node-gyp](doc/node-gyp.md)

doc/creating_a_release.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ tools:
1313

1414
* [Changelog maker](https://www.npmjs.com/package/changelog-maker)
1515

16-
If not please follow the instruction reported in the tool's documentation to
16+
If not please follow the instruction reported in the tool's documentation to
1717
install it.
1818

1919
## Publish new release
@@ -27,13 +27,13 @@ new release. Give people some time to comment or suggest PRs that should land fi
2727

2828
* Update the version in **package.json** appropriately.
2929

30-
* Update the [README.md](https://github.com/nodejs/node-addon-api/blob/master/README.md)
30+
* Update the [README.md](https://github.com/nodejs/node-addon-api/blob/master/README.md)
3131
to show the new version as the latest.
3232

3333
* Generate the changelog for the new version using **changelog maker** tool. From
3434
the route folder of the repo launch the following command:
3535

36-
```bash
36+
```bash
3737
> changelog-maker
3838
```
3939
* Use the output generated by **changelog maker** to pdate the [CHANGELOG.md](https://github.com/nodejs/node-addon-api/blob/master/CHANGELOG.md)
@@ -43,8 +43,8 @@ following the style used in publishing the previous release.
4343

4444
* Validate all tests pass by running npm test on master.
4545

46-
* Use **[CI](https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api/)**
47-
to validate tests pass for latest 11, 10, 8, 6 releases (note there are still some issues on SmartOS and
46+
* Use **[CI](https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api-new/)**
47+
to validate tests pass (note there are still some issues on SmartOS and
4848
Windows in the testing).
4949

5050
* Do a clean checkout of node-addon-api.

0 commit comments

Comments
 (0)