Skip to content

Commit e36f35e

Browse files
authored
Add warning about ref-(struct,array)-napi to README
1 parent b5f574f commit e36f35e

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,17 @@ Generate the docs:
140140
$ npm run docs
141141
```
142142

143+
Incompatible packages
144+
--------------------
145+
146+
The [`ref-struct-napi`](https://www.npmjs.com/package/ref-struct-napi) and
147+
[`ref-array-napi`](https://www.npmjs.com/package/ref-array-napi) packages
148+
have names that sound like they are compatible with this module.
149+
150+
They are not, and your application will experience crashes if you use
151+
them together with `ref-napi`.
152+
Use [`ref-struct-di`](https://www.npmjs.com/package/ref-struct-di)
153+
or [`ref-array-di`](https://www.npmjs.com/package/ref-array-di) instead.
143154

144155
License
145156
-------

0 commit comments

Comments
 (0)