diff --git a/README.md b/README.md index 0a4e646..f0265b2 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,17 @@ in a process to compile and build native addons for Node.js. npm i node-api-headers ``` + + +## Versions + +Node-API C headers are backward-compatible. Its version (e.g. `8`) is released +separately from the Node.js version stream (e.g. `19.8.1`) and changes are +backported to active Node.js LTS lines (e.g. `16.x` and `18.x`). + +This package publishes semver-minor versions with new Node-API C headers changes. +JS API breaking changes are published with new semver-major versions. + ## API @@ -92,4 +103,4 @@ grouped by version and api types. -Licensed under [MIT](./LICENSE.md) \ No newline at end of file +Licensed under [MIT](./LICENSE.md)