From a52c35b4ea26dc0304c03d2bff90655d08f768bc Mon Sep 17 00:00:00 2001 From: Saint Gabriel <53136855+chineduG@users.noreply.github.com> Date: Sat, 4 Jun 2022 01:28:33 +0100 Subject: [PATCH 1/3] Update README.md Corrections of misspelled words. --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7a0a69bf9..1c45dd0f8 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ If you have a local clone, you can update it by running: ```shell git branch -m master main git fetch origin -git branch -u origin/main main +git branch -u origin/main-main ``` # **node-addon-api module** @@ -16,15 +16,15 @@ provided by Node.js when using C++. It provides a C++ object model and exception handling semantics with low overhead. There are three options for implementing addons: Node-API, nan, or direct -use of internal V8, libuv and Node.js libraries. Unless there is a need for -direct access to functionality which is not exposed by Node-API as outlined +use of internal V8, libuv, and Node.js libraries. Unless there is a need for +direct access to functionality that is not exposed by Node-API as outlined in [C/C++ addons](https://nodejs.org/dist/latest/docs/api/addons.html) in Node.js core, use Node-API. Refer to [C/C++ addons with Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html) for more information on Node-API. Node-API is an ABI stable C interface provided by Node.js for building native -addons. It is independent from the underlying JavaScript runtime (e.g. V8 or ChakraCore) +addons. It is independent of the underlying JavaScript runtime (e.g. V8 or ChakraCore) and is maintained as part of Node.js itself. It is intended to insulate native addons from changes in the underlying JavaScript engine and allow modules compiled for one version to run on later versions of Node.js without @@ -46,7 +46,7 @@ provides an [ABI stability guide][] containing a detailed explanation of ABI stability in general, and the Node-API ABI stability guarantee in particular. As new APIs are added to Node-API, node-addon-api must be updated to provide -wrappers for those new APIs. For this reason node-addon-api provides +wrappers for those new APIs. For this reason, node-addon-api provides methods that allow callers to obtain the underlying Node-API handles so direct calls to Node-API and the use of the objects/methods provided by node-addon-api can be used together. For example, in order to be able @@ -56,7 +56,7 @@ APIs exposed by node-addon-api are generally used to create and manipulate JavaScript values. Concepts and operations generally map to ideas specified in the **ECMA262 Language Specification**. -The [Node-API Resource](https://nodejs.github.io/node-addon-examples/) offers an +The [Node-API Resource](https://nodejs.github.io/node-addon-examples/) offers an excellent orientation and tips for developers just getting started with Node-API and node-addon-api. @@ -195,7 +195,7 @@ To run the **node-addon-api** tests with `--debug` option: npm run-script dev ``` -If you want faster build, you might use the following option: +If you want a faster build, you might use the following option: ``` npm run-script dev:incremental @@ -223,7 +223,7 @@ See [benchmark/README.md](benchmark/README.md) for more details about running an As node-addon-api's core mission is to expose the plain C Node-API as C++ wrappers, tools that facilitate n-api/node-addon-api providing more -convenient patterns on developing a Node.js add-ons with n-api/node-addon-api +convenient patterns for developing a Node.js add-on with n-api/node-addon-api can be published to NPM as standalone packages. It is also recommended to tag such packages with `node-addon-api` to provide more visibility to the community. @@ -291,3 +291,4 @@ Licensed under [MIT](./LICENSE.md) [ABI stability guide]: https://nodejs.org/en/docs/guides/abi-stability/ [Node-API support matrix]: https://nodejs.org/dist/latest/docs/api/n-api.html#n_api_n_api_version_matrix + From aaafb782b7144b27d122ade5ea192cc47c806a1a Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sat, 4 Jun 2022 08:58:27 -0700 Subject: [PATCH 2/3] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 1c45dd0f8..8fa5707b7 100644 --- a/README.md +++ b/README.md @@ -291,4 +291,3 @@ Licensed under [MIT](./LICENSE.md) [ABI stability guide]: https://nodejs.org/en/docs/guides/abi-stability/ [Node-API support matrix]: https://nodejs.org/dist/latest/docs/api/n-api.html#n_api_n_api_version_matrix - From 58c2f30b9e5dab4391b009de09b61bbcb9aeec62 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sat, 4 Jun 2022 08:58:56 -0700 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8fa5707b7..ae2e7e1dc 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ If you have a local clone, you can update it by running: ```shell git branch -m master main git fetch origin -git branch -u origin/main-main +git branch -u origin/main main ``` # **node-addon-api module**