Skip to content

Commit c802bcf

Browse files
KevinEadymhdawson
authored andcommitted
Update README.md with implementation docs (#78)
PR-URL: #78 Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
1 parent ed56516 commit c802bcf

1 file changed

Lines changed: 11 additions & 7 deletions

File tree

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
11
Node.js Addon Examples
22
=========================================
3+
**A repository of [Node.js Addons](https://nodejs.org/api/addons.html#addons_c_addons) examples.**
34

4-
This repository is the home of the Addon Examples.
5+
Implementations of examples are named either after Node.js versions (`node_0.10`,
6+
`node_0.12`, etc), or Node.js addon implementation APIs:
7+
- [`nan`](https://github.com/nodejs/nan): C++-based abstraction between Node and direct V8 APIs.
8+
- [`napi`](https://nodejs.org/api/n-api.html): C-based API guaranteeing [ABI stability](https://nodejs.org/en/docs/guides/abi-stability/) across different node versions as well as JavaScript engines.
9+
- [`node-addon-api`](https://github.com/nodejs/node-addon-api): header-only C++ wrapper classes which simplify the use of the C-based N-API.
10+
11+
Implementations against unsupported versions of Node.js are provided for
12+
completess and historical context. They are not maintained.
13+
14+
## Usage
515

616
The directory structure is as follows:
717

@@ -17,12 +27,6 @@ The directory structure is as follows:
1727
.
1828
```
1929

20-
Implementations are named either after Node.js versions (`node_0.10`,
21-
`node_0.12`, etc), or Node.js addon implementation APIs (`nan`, `napi`,
22-
or `node-addon-api`).
23-
24-
Implementations against unsupported versions of Node.js are provided for
25-
completess and historical context. They are not maintained.
2630

2731
In each example's implementation subdirectory, run
2832

0 commit comments

Comments
 (0)