You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
README.md: newline is required before ## headings to render properly (nodejs#653)
newline is required before `##` headings to render properly on
markdown renderers used on websites other than github, such as npmjs.
Signed-off-by: Michael Ira Krufky <[email protected]>
closesnodejs#652
Copy file name to clipboardExpand all lines: README.md
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,9 +24,11 @@ This project also contains some helper utilities that make addon development a b
24
24
***[Governance & Contributing](#governance)**
25
25
26
26
<aname="news"></a>
27
+
27
28
## News & Updates
28
29
29
30
<aname="usage"></a>
31
+
30
32
## Usage
31
33
32
34
Simply add **NAN** as a dependency in the *package.json* of your Node addon:
@@ -46,6 +48,7 @@ Pull in the path to **NAN** in your *binding.gyp* so that you can use `#include
46
48
This works like a `-I<path-to-NAN>` when compiling your addon.
47
49
48
50
<aname="example"></a>
51
+
49
52
## Example
50
53
51
54
Just getting started with Nan? Take a look at the **[Node Add-on Examples](https://github.com/nodejs/node-addon-examples)**.
@@ -59,6 +62,7 @@ Yet another example is **[nan-example-eol](https://github.com/CodeCharmLtd/nan-e
59
62
Also take a look at our comprehensive **[C++ test suite](https://github.com/nodejs/nan/tree/master/test/cpp)** which has a plethora of code snippets for your pasting pleasure.
60
63
61
64
<aname="api"></a>
65
+
62
66
## API
63
67
64
68
Additional to the NAN documentation below, please consult:
@@ -308,6 +312,7 @@ The hooks to access V8 internals—including GC and statistics—are different a
308
312
309
313
310
314
<aname="tests"></a>
315
+
311
316
### Tests
312
317
313
318
To run the NAN tests do:
@@ -326,6 +331,7 @@ make test
326
331
```
327
332
328
333
<aname="governance"></a>
334
+
329
335
## Governance & Contributing
330
336
331
337
NAN is governed by the [io.js](https://iojs.org/) Addon API Working Group
@@ -361,6 +367,7 @@ Modifications of the contents of the NAN repository are made on a collaborative
361
367
If a change proposal cannot reach a consensus, a WG member can call for a vote amongst the members of the WG. Simple majority wins.
362
368
363
369
<aid="developers-certificate-of-origin"></a>
370
+
364
371
## Developer's Certificate of Origin 1.1
365
372
366
373
By making a contribution to this project, I certify that:
@@ -388,6 +395,7 @@ By making a contribution to this project, I certify that:
388
395
this project or the open source license(s) involved.
0 commit comments