From fd65078e3c4a5c05a98bcd88eb155ab4a3866647 Mon Sep 17 00:00:00 2001 From: Gabriel Schulhof Date: Mon, 8 Oct 2018 22:09:57 -0400 Subject: [PATCH] README.md: link to new ABI stability guide Re: https://github.com/nodejs/abi-stable-node/issues/332 PR-URL: https://github.com/nodejs/node-addon-api/pull/367 Reviewed-By: Nicola Del Gobbo Reviewed-By: Sakthipriyan Vairamani Reviewed-By: Michael Dawson --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2c0600c43..581c9fcaa 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,12 @@ of Node.js. It is important to remember that *other* Node.js interfaces such as `libuv` (included in a project via `#include `) are not ABI-stable across -Node.js major versions. Thus, and addon must use N-API and/or `node-addon-api` +Node.js major versions. Thus, an addon must use N-API and/or `node-addon-api` exclusively and build against a version of Node.js that includes an implementation of N-API (meaning a version of Node.js newer than 6.14.2) in -order to benefit from ABI stability across Node.js major versions. +order to benefit from ABI stability across Node.js major versions. Node.js +provides an [ABI stability guide][] containing a detailed explanation of ABI +stability in general, and the N-API ABI stability guarantee in particular. As new APIs are added to N-API, node-addon-api must be updated to provide wrappers for those new APIs. For this reason node-addon-api provides @@ -167,3 +169,5 @@ Take a look and get inspired by our **[test suite](https://github.com/nodejs/nod Licensed under [MIT](./LICENSE.md) + +[ABI stability guide]: https://nodejs.org/en/docs/guides/abi-stability/