Skip to content

Commit 4465612

Browse files
committed
Update README
FIxes #6
1 parent 9d3740d commit 4465612

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
[![npm](https://img.shields.io/npm/v/napi-build-utils.svg)](https://www.npmjs.com/package/napi-build-utils)
44
![Node version](https://img.shields.io/node/v/prebuild.svg)
5-
[![Build Status](https://travis-ci.org/inspiredware/napi-build-utils.svg?branch=master)](https://travis-ci.org/inspiredware/napi-build-utils)
5+
[![Build Status](https://github.com/inspiredware/napi-build-utils/actions/workflows/run-npm-tests.yml/badge.svg?branch=jschlight/issue6)](https://travis-ci.org/inspiredware/napi-build-utils)
66
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
77
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
88

9-
A set of utilities to assist developers of tools that build [N-API](https://nodejs.org/api/n-api.html#n_api_n_api) native add-ons.
9+
A set of utilities to assist developers of tools that build [Node-API](https://nodejs.org/api/n-api.html#n_api_n_api) native add-ons.
1010

1111
## Background
1212

13-
This module is targeted to developers creating tools that build N-API native add-ons.
13+
This module is targeted to developers creating tools that build Node-API native add-ons.
1414

15-
It implements a set of functions that aid in determining the N-API version supported by the currently running Node instance and the set of N-API versions against which the N-API native add-on is designed to be built. Other functions determine whether a particular N-API version can be built and can issue console warnings for unsupported N-API versions.
15+
It implements a set of functions that aid in determining the Node-API version supported by the currently running Node instance and the set of Node-API versions against which the Node-API native add-on is designed to be built. Other functions determine whether a particular Node-API version can be built and can issue console warnings for unsupported Node-API versions.
1616

1717
Unlike the modules this code is designed to facilitate building, this module is written entirely in JavaScript.
1818

@@ -26,22 +26,22 @@ The module exports a set of functions documented [here](./index.md). For example
2626

2727
```javascript
2828
var napiBuildUtils = require('napi-build-utils');
29-
var napiVersion = napiBuildUtils.getNapiVersion(); // N-API version supported by Node, or undefined.
29+
var napiVersion = napiBuildUtils.getNapiVersion(); // Node-API version supported by Node, or undefined.
3030
```
3131

32-
## Declaring supported N-API versions
32+
## Declaring supported Node-API versions
3333

34-
Native modules that are designed to work with [N-API](https://nodejs.org/api/n-api.html#n_api_n_api) must explicitly declare the N-API version(s) against which they are coded to build. This is accomplished by including a `binary.napi_versions` property in the module's `package.json` file. For example:
34+
Native modules that are designed to work with [Node-API](https://nodejs.org/api/n-api.html#n_api_n_api) must explicitly declare the Node-API version(s) against which they are coded to build. This is accomplished by including a `binary.napi_versions` property in the module's `package.json` file. For example:
3535

3636
```json
3737
"binary": {
3838
"napi_versions": [2,3]
3939
}
4040
```
4141

42-
In the absence of a need to compile against a specific N-API version, the value `3` is a good choice as this is the N-API version that was supported when N-API left experimental status.
42+
In the absence of a need to compile against a specific Node-API version, the value `3` is a good choice as this is the Node-API version that was supported when Node-API left experimental status.
4343

44-
Modules that are built against a specific N-API version will continue to operate indefinitely, even as later versions of N-API are introduced.
44+
Modules that are built against a specific Node-API version will continue to operate indefinitely, even as later versions of Node-API are introduced.
4545

4646
## Support
4747

0 commit comments

Comments
 (0)