From bc3186b08f82b6b41a350b0b17f3c234a6f8cd44 Mon Sep 17 00:00:00 2001 From: legendecas Date: Sun, 15 Mar 2020 23:12:51 +0800 Subject: [PATCH 1/5] doc: add phrases on recommending tags of addon helpers --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6ab3ccecd..f36bd8e5a 100644 --- a/README.md +++ b/README.md @@ -160,8 +160,6 @@ npm run-script dev:incremental Take a look and get inspired by our **[test suite](https://github.com/nodejs/node-addon-api/tree/master/test)** - - ### **Benchmarks** You can run the available benchmarks using the following command: @@ -172,16 +170,26 @@ npm run-script benchmark See [benchmark/README.md](benchmark/README.md) for more details about running and adding benchmarks. -## **Contributing** - -We love contributions from the community to **node-addon-api**. -See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on our philosophy around extending this module. + ### **More resource and info about native Addons** - **[C++ Addons](https://nodejs.org/dist/latest/docs/api/addons.html)** - **[N-API](https://nodejs.org/dist/latest/docs/api/n-api.html)** - **[N-API - Next Generation Node API for Native Modules](https://youtu.be/-Oniup60Afs)** +As node-addon-api's core mission is to expose the plain C N-API as C++ +wrappers, tools that facilitates n-api/node-addon-api to provide more +convenient patterns on 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 +the package with `node-addon-api` to expose more visibilities on community. + +Quick links to NPM searches: [keywords:node-addon-api](https://www.npmjs.com/search?q=keywords%3Anode-addon-api). + +## **Contributing** + +We love contributions from the community to **node-addon-api**. +See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on our philosophy around extending this module. + ## Team members From c3a0409368ccf5bb5a16d0ff280cae927a8c0e91 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Wed, 18 Mar 2020 17:37:53 -0400 Subject: [PATCH 2/5] Update README.md Co-Authored-By: Gabriel Schulhof --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f36bd8e5a..7153a5537 100644 --- a/README.md +++ b/README.md @@ -187,7 +187,7 @@ Quick links to NPM searches: [keywords:node-addon-api](https://www.npmjs.com/sea ## **Contributing** -We love contributions from the community to **node-addon-api**. +We love contributions from the community to **node-addon-api**! See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on our philosophy around extending this module. From e3c5a769726a668bab552ebbe0f4a50e903972e4 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Wed, 18 Mar 2020 17:37:59 -0400 Subject: [PATCH 3/5] Update README.md Co-Authored-By: Gabriel Schulhof --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7153a5537..521e42900 100644 --- a/README.md +++ b/README.md @@ -181,7 +181,7 @@ As node-addon-api's core mission is to expose the plain C N-API as C++ wrappers, tools that facilitates n-api/node-addon-api to provide more convenient patterns on 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 -the package with `node-addon-api` to expose more visibilities on community. +such packages with `node-addon-api` to provide more visibility to the community. Quick links to NPM searches: [keywords:node-addon-api](https://www.npmjs.com/search?q=keywords%3Anode-addon-api). From 1fcf509748dff80fe7e36a291e5b61d0393df32e Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Wed, 18 Mar 2020 17:38:16 -0400 Subject: [PATCH 4/5] Update README.md Co-Authored-By: Gabriel Schulhof --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 521e42900..e41083089 100644 --- a/README.md +++ b/README.md @@ -178,7 +178,7 @@ See [benchmark/README.md](benchmark/README.md) for more details about running an - **[N-API - Next Generation Node API for Native Modules](https://youtu.be/-Oniup60Afs)** As node-addon-api's core mission is to expose the plain C N-API as C++ -wrappers, tools that facilitates n-api/node-addon-api to provide more +wrappers, tools that facilitate n-api/node-addon-api providing more convenient patterns on 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. From b154e2eaac518e5945841a9c625689e8319d488f Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Wed, 18 Mar 2020 17:38:22 -0400 Subject: [PATCH 5/5] Update README.md Co-Authored-By: Gabriel Schulhof --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e41083089..52e0c3137 100644 --- a/README.md +++ b/README.md @@ -179,7 +179,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 N-API as C++ wrappers, tools that facilitate n-api/node-addon-api providing more -convenient patterns on developing a Node.js add-on with n-api/node-addon-api +convenient patterns on developing a Node.js add-ons 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.