Skip to content
This repository was archived by the owner on Feb 17, 2019. It is now read-only.

Commit cfdadc4

Browse files
committed
doc: update README.md to reflect repo usage
Update README.md to reflect that repo is for ABI stable PoC as opposed to core addon examples.
1 parent 246b589 commit cfdadc4

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

README.md

+7-10
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
1-
Node.js Addon Examples
2-
======================
1+
Node.js Addon Examples - ABI Stable PoC
2+
=========================================
33

4-
See the Node.js C++ [addons page](http://nodejs.org/docs/latest/api/addons.html) for details of the examples here.
4+
This repository is the home of the Addon Examples as extended
5+
for the proof of concept work being done to develop an ABI
6+
stable API for use my node modules.
57

6-
Each directory contains a subdirectory for:
7-
8-
* **Node 0.10**: Mostly compatible with Node 0.8 and even 0.6, older style V8 programming
9-
* **Node 0.12**: Newer style V8 programming, compatible with Node 0.11+
10-
* **NAN**: The example rewritten using [NAN](https://github.com/rvagg/nan/) for compatibility with Node 0.8 -> 0.11+
11-
12-
You will need [node-gyp](https://github.com/TooTallNate/node-gyp/) installed as a global:
8+
For more details please read the node-eps covering this effort.
9+
The current PR for the eps is: https://github.com/nodejs/node-eps/pull/20
1310

1411
```text
1512
$ sudo npm install node-gyp -g

0 commit comments

Comments
 (0)