From 1f3584bbfa7711459fd221fc36b627987ccfd7cc Mon Sep 17 00:00:00 2001 From: Chengzhong Wu Date: Fri, 14 Apr 2023 10:33:56 +0800 Subject: [PATCH 1/2] doc: explain package version rationale --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a4e646..b4194b8 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) From 300915e730be708471c290e0f0276c0b50e2bb64 Mon Sep 17 00:00:00 2001 From: Chengzhong Wu Date: Mon, 17 Apr 2023 19:24:41 +0800 Subject: [PATCH 2/2] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b4194b8..f0265b2 100644 --- a/README.md +++ b/README.md @@ -45,11 +45,11 @@ npm i node-api-headers ## Versions -Node-api C headers are backward-compatible. Its version (e.g. `8`) is released +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. +This package publishes semver-minor versions with new Node-API C headers changes. JS API breaking changes are published with new semver-major versions.