Skip to content

Commit 5441b3c

Browse files
doc: minor fixes to README.md
PR-URL: #190 Reviewed-By: Arunesh Chandra <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
1 parent 60374e0 commit 5441b3c

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

README.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
11
# **Node.js API (N-API) Package**
22

3-
This package contains **header-only C++ wrapper classes** for the **ABI-stable
4-
Node.js API** also known as **N-API**, providing C++ object model and exception
5-
handling semantics with low overhead. It guarantees backward compatibility with
6-
use with older versions of Node.js that do not have N-API built-in.
7-
8-
Node.js API guarentees the **API** and **ABI** compatibility across different
9-
version of Node.js. So if you switch to a
10-
different version of Node.js you must not reinstall and maybe recompile the
11-
Addon.
12-
13-
N-API is an API for building native Addons. It is independent from the underlying
14-
JavaScript runtime (ex V8) and is maintained as part of Node.js itself. This API
15-
will be Application Binary Interface (ABI) stable across versions of Node.js. It
16-
is intended to insulate Addons from changes in the underlying JavaScript engine
17-
and allow modules compiled for one version to run on later versions of Node.js
18-
without recompilation.
3+
This package contains **header-only C++ wrapper classes** for the
4+
**ABI-stable Node.js API** also known as **N-API**, providing C++ object
5+
model and exception handling semantics with low overhead. It guarantees
6+
backward compatibility when used with older versions of Node.js that do
7+
not have N-API built-in.
8+
9+
N-API is an API for building native addons. It is independent from the
10+
underlying JavaScript runtime (e.g. V8 or ChakraCore) and is maintained as
11+
part of Node.js itself. This API will be Application Binary Interface (ABI)
12+
stable across versions and flavors of Node.js. It is intended to insulate
13+
native addons from changes in the underlying JavaScript engine and allow
14+
modules compiled for one version to run on later versions of Node.js without
15+
recompilation. N-API guarantees the **API** and **ABI** compatibility across
16+
different versions of Node.js. So if you switched to a different version of
17+
Node.js, you would not need to reinstall or recompile the native addon.
1918

2019
APIs exposed by N-API are generally used to create and manipulate JavaScript
2120
values. Concepts and operations generally map to ideas specified in the
@@ -32,9 +31,9 @@ values. Concepts and operations generally map to ideas specified in the
3231

3332
## **Current version: 1.1.0**
3433

35-
(See [CHANHELOG.md](CHANGELOG.md) for complete Changelog)
34+
(See [CHANGELOG.md](CHANGELOG.md) for complete Changelog)
3635

37-
[![NPM](https://nodei.co/npm/node-addon-api.png?downloads=true&downloadRank=true)](https://nodei.co/npm/dode-addon-api/) [![NPM](https://nodei.co/npm-dl/node-addon-api.png?months=6&height=1)](https://nodei.co/npm/dode-addon-api/)
36+
[![NPM](https://nodei.co/npm/node-addon-api.png?downloads=true&downloadRank=true)](https://nodei.co/npm/node-addon-api/) [![NPM](https://nodei.co/npm-dl/node-addon-api.png?months=6&height=1)](https://nodei.co/npm/node-addon-api/)
3837

3938
<a name="setup"></a>
4039

0 commit comments

Comments
 (0)