From 446561288c19a799e1dd715cca74c8ea81b7a3f8 Mon Sep 17 00:00:00 2001 From: Jim Schlight Date: Thu, 16 Jan 2025 15:45:05 -0800 Subject: [PATCH] Update README FIxes #6 --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index e12d5d3..a126c74 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,17 @@ [![npm](https://img.shields.io/npm/v/napi-build-utils.svg)](https://www.npmjs.com/package/napi-build-utils) ![Node version](https://img.shields.io/node/v/prebuild.svg) -[![Build Status](https://travis-ci.org/inspiredware/napi-build-utils.svg?branch=master)](https://travis-ci.org/inspiredware/napi-build-utils) +[![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) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -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. +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. ## Background -This module is targeted to developers creating tools that build N-API native add-ons. +This module is targeted to developers creating tools that build Node-API native add-ons. -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. +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. Unlike the modules this code is designed to facilitate building, this module is written entirely in JavaScript. @@ -26,12 +26,12 @@ The module exports a set of functions documented [here](./index.md). For example ```javascript var napiBuildUtils = require('napi-build-utils'); -var napiVersion = napiBuildUtils.getNapiVersion(); // N-API version supported by Node, or undefined. +var napiVersion = napiBuildUtils.getNapiVersion(); // Node-API version supported by Node, or undefined. ``` -## Declaring supported N-API versions +## Declaring supported Node-API versions -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: +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: ```json "binary": { @@ -39,9 +39,9 @@ Native modules that are designed to work with [N-API](https://nodejs.org/api/n-a } ``` -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. +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. -Modules that are built against a specific N-API version will continue to operate indefinitely, even as later versions of N-API are introduced. +Modules that are built against a specific Node-API version will continue to operate indefinitely, even as later versions of Node-API are introduced. ## Support