Skip to content

Commit d1d4a4a

Browse files
committed
docs(readme): describe napi-derive instead of napi-codegen
1 parent 51d8823 commit d1d4a4a

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,9 @@ This project is covered by a [Code of Conduct](CODE_OF_CONDUCT.md).
1212
[`node_api.h`](https://github.com/nodejs/node/blob/master/src/node_api.h)
1313
using [`bindgen`](https://github.com/rust-lang-nursery/rust-bindgen).
1414
* `napi`: high-level and rusty wrappers around `napi-sys`.
15-
* `napi-codegen`: a compiler plugin designed for you to be able to write a
16-
regular Rust function that takes JavaScript values as arguments and returns a
17-
`NapiResult`, put an annotation, and be good to go. It's not clear at this
18-
point whether we will continue taking this route, though. On the second
19-
thought, pretty function signatures don't seem worth diving into the hassle
20-
of maintaining compatibility with the latest nightly compiler and requiring
21-
using it. Good old macros and just a little bit of boilerplate code will
22-
solve the problem as well.
15+
* `napi-derive`: contains a procedural macro that allows to construct typesafe
16+
structures that represent function parameters from JavaScript function call
17+
arguments and automatically validate them.
2318

2419
[travis-badge]: https://travis-ci.org/aqrln/napi-rs.svg?branch=master
2520
[travis-url]: https://travis-ci.org/aqrln/napi-rs

0 commit comments

Comments
 (0)