diff --git a/README.md b/README.md index a67051d00..93379a198 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ It is important to remember that *other* Node.js interfaces such as `libuv` (included in a project via `#include `) are not ABI-stable across Node.js major versions. Thus, an addon must use N-API and/or `node-addon-api` exclusively and build against a version of Node.js that includes an -implementation of N-API (meaning a version of Node.js newer than 6.14.2) in +implementation of N-API (meaning an active LTS version of Node.js) in order to benefit from ABI stability across Node.js major versions. Node.js provides an [ABI stability guide][] containing a detailed explanation of ABI stability in general, and the N-API ABI stability guarantee in particular. @@ -47,7 +47,7 @@ to ideas specified in the **ECMA262 Language Specification**. - **[Contributors](#contributors)** - **[License](#license)** -## **Current version: 2.0.0** +## **Current version: 3.0.0** (See [CHANGELOG.md](CHANGELOG.md) for complete Changelog) @@ -55,6 +55,13 @@ to ideas specified in the **ECMA262 Language Specification**. +node-addon-api is based on [N-API](https://nodejs.org/api/n-api.html) and supports using different N-API versions. +This allows addons built with it to run with Node.js versions which support the targeted N-API version. +**However** the node-addon-api support model is to support only the active LTS Node.js versions. This means that +every year there will be a new major which drops support for the Node.js LTS version which has gone out of service. + +The oldest Node.js version supported by the current version of node-addon-api is Node.js 10.x. + ## Setup - [Installation and usage](doc/setup.md) - [node-gyp](doc/node-gyp.md) diff --git a/doc/creating_a_release.md b/doc/creating_a_release.md index bc9a859e0..beb67d287 100644 --- a/doc/creating_a_release.md +++ b/doc/creating_a_release.md @@ -13,7 +13,7 @@ tools: * [Changelog maker](https://www.npmjs.com/package/changelog-maker) -If not please follow the instruction reported in the tool's documentation to +If not please follow the instruction reported in the tool's documentation to install it. ## Publish new release @@ -27,13 +27,13 @@ new release. Give people some time to comment or suggest PRs that should land fi * Update the version in **package.json** appropriately. -* Update the [README.md](https://github.com/nodejs/node-addon-api/blob/master/README.md) +* Update the [README.md](https://github.com/nodejs/node-addon-api/blob/master/README.md) to show the new version as the latest. * Generate the changelog for the new version using **changelog maker** tool. From the route folder of the repo launch the following command: - ```bash + ```bash > changelog-maker ``` * 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. * Validate all tests pass by running npm test on master. -* Use **[CI](https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api/)** -to validate tests pass for latest 11, 10, 8, 6 releases (note there are still some issues on SmartOS and +* Use **[CI](https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api-new/)** +to validate tests pass (note there are still some issues on SmartOS and Windows in the testing). * Do a clean checkout of node-addon-api.