@@ -42,6 +42,7 @@ to ideas specified in the **ECMA262 Language Specification**.
42
42
- ** [ Examples] ( #examples ) **
43
43
- ** [ Tests] ( #tests ) **
44
44
- ** [ More resource and info about native Addons] ( #resources ) **
45
+ - ** [ Badges] ( #badges ) **
45
46
- ** [ Code of Conduct] ( CODE_OF_CONDUCT.md ) **
46
47
- ** [ Contributors] ( #contributors ) **
47
48
- ** [ License] ( #license ) **
@@ -185,6 +186,24 @@ such packages with `node-addon-api` to provide more visibility to the community.
185
186
186
187
Quick links to NPM searches: [ keywords: node-addon-api ] ( https://www.npmjs.com/search?q=keywords%3Anode-addon-api ) .
187
188
189
+ <a name =" badges " ></a >
190
+
191
+ ### ** Badges**
192
+
193
+ The use of badges is recommended to indicate the minimum version of N-API
194
+ required for the module. This helps to determine which Node.js major versions are
195
+ supported. Addon maintainers can consult the [ N-API support matrix] [ ] to determine
196
+ which Node.js versions provide a given N-API version. The following badges are
197
+ available:
198
+
199
+ ![ N-API v1 Badge] ( https://github.com/nodejs/abi-stable-node/blob/doc/assets/N-API%20v1%20Badge.svg )
200
+ ![ N-API v2 Badge] ( https://github.com/nodejs/abi-stable-node/blob/doc/assets/N-API%20v2%20Badge.svg )
201
+ ![ N-API v3 Badge] ( https://github.com/nodejs/abi-stable-node/blob/doc/assets/N-API%20v3%20Badge.svg )
202
+ ![ N-API v4 Badge] ( https://github.com/nodejs/abi-stable-node/blob/doc/assets/N-API%20v4%20Badge.svg )
203
+ ![ N-API v5 Badge] ( https://github.com/nodejs/abi-stable-node/blob/doc/assets/N-API%20v5%20Badge.svg )
204
+ ![ N-API v6 Badge] ( https://github.com/nodejs/abi-stable-node/blob/doc/assets/N-API%20v6%20Badge.svg )
205
+ ![ N-API Experimental Version Badge] ( https://github.com/nodejs/abi-stable-node/blob/doc/assets/N-API%20Experimental%20Version%20Badge.svg )
206
+
188
207
## ** Contributing**
189
208
190
209
We love contributions from the community to ** node-addon-api** !
@@ -220,3 +239,4 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on our philosophy around
220
239
Licensed under [ MIT] ( ./LICENSE.md )
221
240
222
241
[ ABI stability guide ] : https://nodejs.org/en/docs/guides/abi-stability/
242
+ [ N-API support matrix ] : https://nodejs.org/dist/latest/docs/api/n-api.html#n_api_n_api_version_matrix
0 commit comments