Skip to content

Commit 4d27697

Browse files
committed
docs(readme): create rudimentary README.md
1 parent 5b8a014 commit 4d27697

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Node.js N-API for Rust! [work in progress]
2+
3+
[![Build Status][travis-badge]][travis-url]
4+
5+
## Crates
6+
7+
* `napi-sys`: low-level bindings to N-API generated from
8+
[`node_api.h`](https://github.com/nodejs/node/blob/master/src/node_api.h)
9+
using [`bindgen`](https://github.com/rust-lang-nursery/rust-bindgen).
10+
* `napi`: high-level and rusty wrappers around `napi-sys`.
11+
* `napi-codegen`: a compiler plugin designed for you to be able to write a
12+
regular Rust function that takes JavaScript values as arguments and returns a
13+
`NapiResult`, put an annotation, and be good to go. It's not clear at this
14+
point whether we will continue taking this route, though. On the second
15+
thought, pretty function signatures don't seem worth diving into the hassle
16+
of maintaining compatibility with the latest nightly compiler and requiring
17+
using it. Good old macros and just a little bit of boilerplate code will
18+
solve the problem as well.
19+
20+
[travis-badge]: https://travis-ci.org/aqrln/napi-rs.svg?branch=master
21+
[travis-url]: https://travis-ci.org/aqrln/napi-rs

0 commit comments

Comments
 (0)