From 6c316a23d70c5813ce20516d86ff27920e6bdf7b Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Sun, 16 Dec 2018 17:11:44 +0200 Subject: [PATCH] Document new platform support and prebuilt binaries (#558) --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1686cbd4..78d86a6d 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,9 @@ See the section on safety below for details of known unsaf ## Supported Platforms -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: +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`. + +The `leveldown` npm package ships with prebuilt binaries for popular 64-bit platforms and is known to work on: * **Linux** (including ARM platforms such as Raspberry Pi *and Kindle!*) * **Mac OS** @@ -39,7 +41,7 @@ We aim to support *at least* Active LTS and Current Node.js releases. `leveldown * **FreeBSD** * **Windows** -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). +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). 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`.