Skip to content

Commit

Permalink
doc: Removed references to Node.js lower than 10.x. (#709)
Browse files Browse the repository at this point in the history
* Removed references to Node.js lower than 10.x.
  • Loading branch information
NickNaso committed Apr 29, 2020
1 parent 9c9accf commit 187318e
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ It is important to remember that *other* Node.js interfaces such as
`libuv` (included in a project via `#include <uv.h>`) 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.
Expand All @@ -47,14 +47,21 @@ 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)

[![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/)

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

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)
Expand Down
10 changes: 5 additions & 5 deletions doc/creating_a_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
Expand All @@ -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.
Expand Down

0 comments on commit 187318e

Please sign in to comment.