Skip to content

Commit 130338d

Browse files
authored
doc: explain package version rationale (#26)
* doc: explain package version rationale * Update README.md
1 parent 1a32803 commit 130338d

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,17 @@ in a process to compile and build native addons for Node.js.
4141
npm i node-api-headers
4242
```
4343

44+
<a name="versions"></a>
45+
46+
## Versions
47+
48+
Node-API C headers are backward-compatible. Its version (e.g. `8`) is released
49+
separately from the Node.js version stream (e.g. `19.8.1`) and changes are
50+
backported to active Node.js LTS lines (e.g. `16.x` and `18.x`).
51+
52+
This package publishes semver-minor versions with new Node-API C headers changes.
53+
JS API breaking changes are published with new semver-major versions.
54+
4455
<a name="api"></a>
4556

4657
## API
@@ -92,4 +103,4 @@ grouped by version and api types.
92103

93104
<a name="license"></a>
94105

95-
Licensed under [MIT](./LICENSE.md)
106+
Licensed under [MIT](./LICENSE.md)

0 commit comments

Comments
 (0)