From 43f6792f9ecf81c8113b58a4b092e7ef1107a864 Mon Sep 17 00:00:00 2001 From: Gabriel Schulhof Date: Tue, 4 Sep 2018 10:03:50 -0400 Subject: [PATCH] README.md: Add blurb about ABI stability --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 700b4db72..9d4011575 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,13 @@ provided by N-API. As such, modules built against one version of Node.js using node-addon-api should run without having to be rebuilt with newer versions 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` +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. + 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 methods that allow callers to obtain the underlying N-API handles so