Skip to content

doc: explain package version rationale #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NickNaso merged 2 commits into from
Apr 20, 2023
Merged

doc: explain package version rationale #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f3584b
doc: explain package version rationale
legendecas Apr 14, 2023
300915e
Update README.md
legendecas Apr 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,17 @@ in a process to compile and build native addons for Node.js.
npm i node-api-headers
```

<a name="versions"></a>

## 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.

<a name="api"></a>

## API
Expand Down Expand Up @@ -92,4 +103,4 @@ grouped by version and api types.

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

Licensed under [MIT](./LICENSE.md)
Licensed under [MIT](./LICENSE.md)