From e36f35eaa653bb599be158a83f3ca519b46718e9 Mon Sep 17 00:00:00 2001 From: Anna Henningsen Date: Sat, 27 Mar 2021 20:40:46 +0100 Subject: [PATCH] Add warning about ref-(struct,array)-napi to README --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index b636f75..ac3877d 100644 --- a/README.md +++ b/README.md @@ -140,6 +140,17 @@ Generate the docs: $ npm run docs ``` +Incompatible packages +-------------------- + +The [`ref-struct-napi`](https://www.npmjs.com/package/ref-struct-napi) and +[`ref-array-napi`](https://www.npmjs.com/package/ref-array-napi) packages +have names that sound like they are compatible with this module. + +They are not, and your application will experience crashes if you use +them together with `ref-napi`. +Use [`ref-struct-di`](https://www.npmjs.com/package/ref-struct-di) +or [`ref-array-di`](https://www.npmjs.com/package/ref-array-di) instead. License -------