Skip to content

Commit 6b8dd47

Browse files
committed
Added badge section to documentation.
1 parent 89e62a9 commit 6b8dd47

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ to ideas specified in the **ECMA262 Language Specification**.
4242
- **[Examples](#examples)**
4343
- **[Tests](#tests)**
4444
- **[More resource and info about native Addons](#resources)**
45+
- **[Badges](#badges)**
4546
- **[Code of Conduct](CODE_OF_CONDUCT.md)**
4647
- **[Contributors](#contributors)**
4748
- **[License](#license)**
@@ -185,6 +186,24 @@ such packages with `node-addon-api` to provide more visibility to the community.
185186

186187
Quick links to NPM searches: [keywords:node-addon-api](https://www.npmjs.com/search?q=keywords%3Anode-addon-api).
187188

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+
188207
## **Contributing**
189208

190209
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
220239
Licensed under [MIT](./LICENSE.md)
221240

222241
[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

Comments
 (0)