Skip to content
This repository was archived by the owner on Dec 1, 2024. It is now read-only.

Commit 6c316a2

Browse files
authored
Document new platform support and prebuilt binaries (#558)
1 parent 1c30125 commit 6c316a2

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,17 @@ See the section on <a href="#safety">safety</a> below for details of known unsaf
3131

3232
## Supported Platforms
3333

34-
We aim to support *at least* Active LTS and Current Node.js releases. `leveldown` ships with prebuilt binaries for [many platforms](https://github.com/Level/leveldown/releases) and is known to work on:
34+
We aim to support *at least* Active LTS and Current Node.js releases, as well as any future Node.js release thanks to [N-API](https://nodejs.org/api/n-api.html). Because N-API has an experimental status in node 6 and early 8.x releases, the minimum node version for `leveldown` is `8.6.0`.
35+
36+
The `leveldown` npm package ships with prebuilt binaries for popular 64-bit platforms and is known to work on:
3537

3638
* **Linux** (including ARM platforms such as Raspberry Pi *and Kindle!*)
3739
* **Mac OS**
3840
* **Solaris** (SmartOS & Nodejitsu)
3941
* **FreeBSD**
4042
* **Windows**
4143

42-
When installing `leveldown`, [`prebuild-install`](https://github.com/prebuild/prebuild-install) will install prebuilt binaries from GitHub if they exist and fallback to a compile step if they don't. In that case you'll need a [valid `node-gyp` installation](https://github.com/nodejs/node-gyp#installation).
44+
When installing `leveldown`, [`node-gyp-build`](https://github.com/mafintosh/node-gyp-build) will check if a compatible binary exists and fallback to a compile step if it doesn't. In that case you'll need a [valid `node-gyp` installation](https://github.com/nodejs/node-gyp#installation).
4345

4446
If you don't want to use the prebuilt binary for the platform you are installing on, specify the `--build-from-source` flag when you install. If you are working on `leveldown` itself and want to re-compile the C++ code it's enough to do `npm install`.
4547

0 commit comments

Comments
 (0)