groove-dev 0.27.93 → 0.27.96

package/node_modules/napi-build-utils/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 inspiredware
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/node_modules/napi-build-utils/README.md

@@ -0,0 +1,52 @@
+# napi-build-utils
+
+[![npm](https://img.shields.io/npm/v/napi-build-utils.svg)](https://www.npmjs.com/package/napi-build-utils)
+![Node version](https://img.shields.io/node/v/prebuild.svg)
+![Build Status](https://github.com/inspiredware/napi-build-utils/actions/workflows/run-npm-tests.yml/badge.svg)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A set of utilities to assist developers of tools that build [Node-API](https://nodejs.org/api/n-api.html#n_api_n_api) native add-ons.
+
+## Background
+
+This module is targeted to developers creating tools that build Node-API native add-ons.
+
+It implements a set of functions that aid in determining the Node-API version supported by the currently running Node instance and the set of Node-API versions against which the Node-API native add-on is designed to be built. Other functions determine whether a particular Node-API version can be built and can issue console warnings for unsupported Node-API versions.
+
+Unlike the modules this code is designed to facilitate building, this module is written entirely in JavaScript.
+
+## Quick start
+
+```bash
+npm install napi-build-utils
+```
+
+The module exports a set of functions documented [here](./index.md). For example:
+
+```javascript
+var napiBuildUtils = require('napi-build-utils');
+var napiVersion = napiBuildUtils.getNapiVersion(); // Node-API version supported by Node, or undefined.
+```
+
+## Declaring supported Node-API versions
+
+Native modules that are designed to work with [Node-API](https://nodejs.org/api/n-api.html#n_api_n_api) must explicitly declare the Node-API version(s) against which they are coded to build. This is accomplished by including a `binary.napi_versions` property in the module's `package.json` file. For example:
+
+```json
+"binary": {
+  "napi_versions": [2,3]
+}
+```
+
+In the absence of a need to compile against a specific Node-API version, the value `3` is a good choice as this is the Node-API version that was supported when Node-API left experimental status.
+
+Modules that are built against a specific Node-API version will continue to operate indefinitely, even as later versions of Node-API are introduced.
+
+## History
+
+**v2.0.0** This version was introduced to address a limitation when the Node-API version reached `10` in NodeJS `v23.6.0`. There was no change in the API, but a SemVer bump to `2.0.0` was made out of an abundance of caution.
+
+## Support
+
+If you run into problems or limitations, please file an issue and we'll take a look. Pull requests are also welcome.

package/node_modules/napi-build-utils/index.js

@@ -0,0 +1,214 @@
+'use strict'
+// Copyright (c) 2018 inspiredware
+
+var path = require('path')
+var pkg = require(path.resolve('package.json'))
+
+var versionArray = process.version
+  .substr(1)
+  .replace(/-.*$/, '')
+  .split('.')
+  .map(function (item) {
+    return +item
+  })
+
+/**
+ *
+ * A set of utilities to assist developers of tools that build
+ * [N-API](https://nodejs.org/api/n-api.html#n_api_n_api) native add-ons.
+ *
+ * The main repository can be found
+ * [here](https://github.com/inspiredware/napi-build-utils#napi-build-utils).
+ *
+ * @module napi-build-utils
+ */
+
+/**
+ * Implements a consistent name of `napi` for N-API runtimes.
+ *
+ * @param {string} runtime The runtime string.
+ * @returns {boolean}
+ */
+exports.isNapiRuntime = function (runtime) {
+  return runtime === 'napi'
+}
+
+/**
+ * Determines whether the specified N-API version is supported
+ * by both the currently running Node instance and the package.
+ *
+ * @param {string} napiVersion The N-API version to check.
+ * @returns {boolean}
+ */
+exports.isSupportedVersion = function (napiVersion) {
+  var version = parseInt(napiVersion, 10)
+  return version <= exports.getNapiVersion() && exports.packageSupportsVersion(version)
+}
+
+/**
+ * Determines whether the specified N-API version is supported by the package.
+ * The N-API version must be present in the `package.json`
+ * `binary.napi_versions` array.
+ *
+ * @param {number} napiVersion The N-API version to check.
+ * @returns {boolean}
+ * @private
+ */
+exports.packageSupportsVersion = function (napiVersion) {
+  if (pkg.binary && pkg.binary.napi_versions &&
+      pkg.binary.napi_versions instanceof Array) { // integer array
+    for (var i = 0; i < pkg.binary.napi_versions.length; i++) {
+      if (pkg.binary.napi_versions[i] === napiVersion) return true
+    };
+  };
+  return false
+}
+
+/**
+ * Issues a warning to the supplied log if the N-API version is not supported
+ * by the current Node instance or if the N-API version is not supported
+ * by the package.
+ *
+ * @param {string} napiVersion The N-API version to check.
+ * @param {Object} log The log object to which the warnings are to be issued.
+ * Must implement the `warn` method.
+ */
+exports.logUnsupportedVersion = function (napiVersion, log) {
+  if (!exports.isSupportedVersion(napiVersion)) {
+    if (exports.packageSupportsVersion(napiVersion)) {
+      log.warn('This Node instance does not support N-API version ' + napiVersion)
+    } else {
+      log.warn('This package does not support N-API version ' + napiVersion)
+    }
+  }
+}
+
+/**
+ * Issues warnings to the supplied log for those N-API versions not supported
+ * by the N-API runtime or the package.
+ *
+ * Note that this function is specific to the
+ * [`prebuild`](https://github.com/prebuild/prebuild#prebuild) package.
+ *
+ * `target` is the list of targets to be built and is determined in one of
+ * three ways from the command line arguments:
+ * (1) `--target` specifies a specific target to build.
+ * (2) `--all` specifies all N-API versions supported by the package.
+ * (3) Neither of these specifies to build the single "best version available."
+ *
+ * `prebuild` is an array of objects in the form `{runtime: 'napi', target: '2'}`.
+ * The array contains the list of N-API versions that are supported by both the
+ * package being built and the currently running Node instance.
+ *
+ * The objective of this function is to issue a warning for those items that appear
+ * in the `target` argument but not in the `prebuild` argument.
+ * If a specific target is supported by the package (`packageSupportsVersion`) but
+ * but note in `prebuild`, the assumption is that the target is not supported by
+ * Node.
+ *
+ * @param {(Array<string>|string)} target The N-API version(s) to check. Target is
+ * @param {Array<Object>} prebuild A config object created by the `prebuild` package.
+ * @param {Object} log The log object to which the warnings are to be issued.
+ * Must implement the `warn` method.
+ * @private
+ */
+exports.logMissingNapiVersions = function (target, prebuild, log) {
+  if (exports.getNapiBuildVersions()) {
+    var targets = [].concat(target)
+    targets.forEach(function (napiVersion) {
+      if (!prebuildExists(prebuild, napiVersion)) {
+        if (exports.packageSupportsVersion(parseInt(napiVersion, 10))) {
+          log.warn('This Node instance does not support N-API version ' + napiVersion)
+        } else {
+          log.warn('This package does not support N-API version ' + napiVersion)
+        }
+      }
+    })
+  } else {
+    log.error('Builds with runtime \'napi\' require a binary.napi_versions ' +
+              'property on the package.json file')
+  }
+}
+
+/**
+ * Determines whether the specified N-API version exists in the prebuild
+ * configuration object.
+ *
+ * Note that this function is specific to the `prebuild` and `prebuild-install`
+ * packages.
+ *
+ * @param {Object} prebuild A config object created by the `prebuild` package.
+ * @param {string} napiVersion The N-APi version to be checked.
+ * @return {boolean}
+ * @private
+ */
+var prebuildExists = function (prebuild, napiVersion) {
+  if (prebuild) {
+    for (var i = 0; i < prebuild.length; i++) {
+      if (prebuild[i].target === napiVersion) return true
+    }
+  }
+  return false
+}
+
+/**
+ * Returns the best N-API version to build given the highest N-API
+ * version supported by the current Node instance and the N-API versions
+ * supported by the package, or undefined if a suitable N-API version
+ * cannot be determined.
+ *
+ * The best build version is the greatest N-API version supported by
+ * the package that is less than or equal to the highest N-API version
+ * supported by the current Node instance.
+ *
+ * @returns {number|undefined}
+ */
+exports.getBestNapiBuildVersion = function () {
+  var bestNapiBuildVersion = 0
+  var napiBuildVersions = exports.getNapiBuildVersions(pkg) // array of integer strings
+  if (napiBuildVersions) {
+    var ourNapiVersion = exports.getNapiVersion()
+    napiBuildVersions.forEach(function (napiBuildVersionStr) {
+      var napiBuildVersion = parseInt(napiBuildVersionStr, 10)
+      if (napiBuildVersion > bestNapiBuildVersion &&
+        napiBuildVersion <= ourNapiVersion) {
+        bestNapiBuildVersion = napiBuildVersion
+      }
+    })
+  }
+  return bestNapiBuildVersion === 0 ? undefined : bestNapiBuildVersion
+}
+
+/**
+ * Returns an array of N-API versions supported by the package.
+ *
+ * @returns {Array<string>|undefined}
+ */
+exports.getNapiBuildVersions = function () {
+  var napiBuildVersions = []
+  // remove duplicates, convert to text
+  if (pkg.binary && pkg.binary.napi_versions) {
+    pkg.binary.napi_versions.forEach(function (napiVersion) {
+      var duplicated = napiBuildVersions.indexOf('' + napiVersion) !== -1
+      if (!duplicated) {
+        napiBuildVersions.push('' + napiVersion)
+      }
+    })
+  }
+  return napiBuildVersions.length ? napiBuildVersions : undefined
+}
+
+/**
+ * Returns the highest N-API version supported by the current node instance
+ * or undefined if N-API is not supported.
+ *
+ * @returns {string|undefined}
+ */
+exports.getNapiVersion = function () {
+  var version = process.versions.napi // integer string, can be undefined
+  if (!version) { // this code should never need to be updated
+    if (versionArray[0] === 9 && versionArray[1] >= 3) version = '2' // 9.3.0+
+    else if (versionArray[0] === 8) version = '1' // 8.0.0+
+  }
+  return version
+}

package/node_modules/napi-build-utils/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "napi-build-utils",
+  "version": "2.0.0",
+  "description": "A set of utilities to assist developers of tools that build N-API native add-ons",
+  "main": "index.js",
+  "scripts": {
+    "doc": "jsdoc2md index.js >index.md",
+    "test": "mocha test/ && npm run lint",
+    "lint": "standard",
+    "prepublishOnly": "npm run test"
+  },
+  "keywords": [
+    "n-api",
+    "prebuild",
+    "prebuild-install"
+  ],
+  "author": "Jim Schlight",
+  "license": "MIT",
+  "homepage": "https://github.com/inspiredware/napi-build-utils#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/inspiredware/napi-build-utils.git"
+  },
+  "bugs": {
+    "url": "https://github.com/inspiredware/napi-build-utils/issues"
+  },
+  "devDependencies": {
+    "chai": "^4.1.2",
+    "jsdoc-to-markdown": "^4.0.1",
+    "mocha": "^5.2.0",
+    "standard": "^12.0.1"
+  },
+  "binary": {
+    "note": "napi-build-tools is not an N-API module. This entry is for unit testing.",
+    "napi_versions": [
+      2,
+      2,
+      3,
+      10
+    ]
+  }
+}

package/node_modules/prebuild-install/CHANGELOG.md

@@ -0,0 +1,131 @@
+# Changelog
+
+## [7.1.3] - 2025-01-22
+
+### Fixed
+
+- Bump napi-build-utils from 1 to 2 ([#204](https://github.com/prebuild/prebuild-install/issues/204)) ([`1bf4a15`](https://github.com/prebuild/prebuild-install/commit/1bf4a15)) (Bailey Pearson)
+
+## [7.1.2] - 2024-02-29
+
+### Fixed
+
+- Support environments where MD5 is prohibited ([#191](https://github.com/prebuild/prebuild-install/issues/191)) ([`9140468`](https://github.com/prebuild/prebuild-install/commit/9140468)) (Tomasz Szuba)
+
+## [7.1.1] - 2022-06-07
+
+### Fixed
+
+- Replace use of npmlog dependency with console.error ([#182](https://github.com/prebuild/prebuild-install/issues/182)) ([`4e2284c`](https://github.com/prebuild/prebuild-install/commit/4e2284c)) (Lovell Fuller)
+- Ensure script output can be captured by tests ([#181](https://github.com/prebuild/prebuild-install/issues/181)) ([`d1853cb`](https://github.com/prebuild/prebuild-install/commit/d1853cb)) (Lovell Fuller)
+
+## [7.1.0] - 2022-04-20
+
+### Changed
+
+- Allow setting libc to glibc on non-glibc platform ([#176](https://github.com/prebuild/prebuild-install/issues/176)) ([`f729abb`](https://github.com/prebuild/prebuild-install/commit/f729abb)) (Joona Heinikoski)
+
+## [7.0.1] - 2022-01-28
+
+### Changed
+
+- Upgrade to the latest version of `detect-libc` ([#166](https://github.com/prebuild/prebuild-install/issues/166)) ([`f71c6b9`](https://github.com/prebuild/prebuild-install/commit/f71c6b9)) (Lovell Fuller)
+
+## [7.0.0] - 2021-11-12
+
+### Changed
+
+- **Breaking:** bump `node-abi` so that Electron 14+ gets correct ABI ([#161](https://github.com/prebuild/prebuild-install/issues/161)) ([`477f347`](https://github.com/prebuild/prebuild-install/commit/477f347)) (csett86). Drops support of Node.js < 10.
+- Bump `simple-get` ([`7468c14`](https://github.com/prebuild/prebuild-install/commit/7468c14)) (Vincent Weevers).
+
+## [6.1.4] - 2021-08-11
+
+### Fixed
+
+- Move auth token to header instead of query param ([#160](https://github.com/prebuild/prebuild-install/issues/160)) ([`b3fad76`](https://github.com/prebuild/prebuild-install/commit/b3fad76)) (nicolai-nordic)
+- Remove `_` prefix as it isn't allowed by npm config ([#153](https://github.com/prebuild/prebuild-install/issues/153)) ([`a964e5b`](https://github.com/prebuild/prebuild-install/commit/a964e5b)) (Tom Boothman)
+- Make `rc.path` absolute ([#158](https://github.com/prebuild/prebuild-install/issues/158)) ([`57bcc06`](https://github.com/prebuild/prebuild-install/commit/57bcc06)) (George Waters).
+
+## [6.1.3] - 2021-06-03
+
+### Changed
+
+- Inline no longer maintained `noop-logger` ([#155](https://github.com/prebuild/prebuild-install/issues/155)) ([`e08d75a`](https://github.com/prebuild/prebuild-install/commit/e08d75a)) (Alexandru Dima)
+- Point users towards `prebuildify` in README ([#150](https://github.com/prebuild/prebuild-install/issues/150)) ([`5ee1a2f`](https://github.com/prebuild/prebuild-install/commit/5ee1a2f)) (Vincent Weevers)
+
+## [6.1.2] - 2021-04-24
+
+### Fixed
+
+- Support URL-safe strings in scoped packages ([#148](https://github.com/prebuild/prebuild-install/issues/148)) ([`db36c7a`](https://github.com/prebuild/prebuild-install/commit/db36c7a)) (Marco)
+
+## [6.1.1] - 2021-04-04
+
+### Fixed
+
+- Support `force` & `buildFromSource` options in yarn ([#140](https://github.com/prebuild/prebuild-install/issues/140)) ([`8cb1ced`](https://github.com/prebuild/prebuild-install/commit/8cb1ced)) (João Moreno)
+- Bump `node-abi` to prevent dedupe (closes [#135](https://github.com/prebuild/prebuild-install/issues/135)) ([`2950fb2`](https://github.com/prebuild/prebuild-install/commit/2950fb2)) (Vincent Weevers)
+
+## [6.1.0] - 2021-04-03
+
+### Added
+
+- Restore local prebuilds feature ([#137](https://github.com/prebuild/prebuild-install/issues/137)) ([`dc4e5ea`](https://github.com/prebuild/prebuild-install/commit/dc4e5ea)) (Wes Roberts). Previously removed in [#81](https://github.com/prebuild/prebuild-install/issues/81) / [`a069253`](https://github.com/prebuild/prebuild-install/commit/a06925378d38ca821bfa93aa4c1fdedc253b2420).
+
+## [6.0.1] - 2021-02-14
+
+### Fixed
+
+- Fixes empty `--tag-prefix` ([#143](https://github.com/prebuild/prebuild-install/issues/143)) ([**@mathiask88**](https://github.com/mathiask88))
+
+## [6.0.0] - 2020-10-23
+
+### Changed
+
+- **Breaking:** don't skip downloads in standalone mode ([`b6f3b36`](https://github.com/prebuild/prebuild-install/commit/b6f3b36)) ([**@vweevers**](https://github.com/vweevers))
+
+### Added
+
+- Document cross platform options ([`e5c9a5a`](https://github.com/prebuild/prebuild-install/commit/e5c9a5a)) ([**@fishbone1**](https://github.com/fishbone1))
+
+### Removed
+
+- **Breaking:** remove `--compile` and `--prebuild` options ([`94f2492`](https://github.com/prebuild/prebuild-install/commit/94f2492)) ([**@vweevers**](https://github.com/vweevers))
+
+### Fixed
+
+- Support npm 7 ([`8acccac`](https://github.com/prebuild/prebuild-install/commit/8acccac), [`08eaf6d`](https://github.com/prebuild/prebuild-install/commit/08eaf6d), [`22175b8`](https://github.com/prebuild/prebuild-install/commit/22175b8)) ([**@vweevers**](https://github.com/vweevers))
+
+## [5.3.6] - 2020-10-20
+
+### Changed
+
+- Replace `mkdirp` dependency with `mkdirp-classic` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+
+[7.1.3]: https://github.com/prebuild/prebuild-install/releases/tag/v7.1.3
+
+[7.1.2]: https://github.com/prebuild/prebuild-install/releases/tag/v7.1.2
+
+[7.1.1]: https://github.com/prebuild/prebuild-install/releases/tag/v7.1.1
+
+[7.1.0]: https://github.com/prebuild/prebuild-install/releases/tag/v7.1.0
+
+[7.0.1]: https://github.com/prebuild/prebuild-install/releases/tag/v7.0.1
+
+[7.0.0]: https://github.com/prebuild/prebuild-install/releases/tag/v7.0.0
+
+[6.1.4]: https://github.com/prebuild/prebuild-install/releases/tag/v6.1.4
+
+[6.1.3]: https://github.com/prebuild/prebuild-install/releases/tag/v6.1.3
+
+[6.1.2]: https://github.com/prebuild/prebuild-install/releases/tag/v6.1.2
+
+[6.1.1]: https://github.com/prebuild/prebuild-install/releases/tag/v6.1.1
+
+[6.1.0]: https://github.com/prebuild/prebuild-install/releases/tag/v6.1.0
+
+[6.0.1]: https://github.com/prebuild/prebuild-install/releases/tag/v6.0.1
+
+[6.0.0]: https://github.com/prebuild/prebuild-install/releases/tag/v6.0.0
+
+[5.3.6]: https://github.com/prebuild/prebuild-install/releases/tag/v5.3.6

package/node_modules/prebuild-install/CONTRIBUTING.md

@@ -0,0 +1,6 @@
+# Contributing to prebuild
+
+- no commits direct to master
+- all commits as pull requests (one or several per PR)
+- each commit solves one identifiable problem
+- never merge one's own PRs, another contributor does this

package/node_modules/prebuild-install/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Mathias Buus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/node_modules/prebuild-install/README.md

@@ -0,0 +1,163 @@
+# prebuild-install
+
+> **A command line tool to easily install prebuilt binaries for multiple versions of Node.js & Electron on a specific platform.**
+> By default it downloads prebuilt binaries from a GitHub release.
+
+[![npm](https://img.shields.io/npm/v/prebuild-install.svg)](https://www.npmjs.com/package/prebuild-install)
+![Node version](https://img.shields.io/node/v/prebuild-install.svg)
+[![Test](https://img.shields.io/github/workflow/status/prebuild/prebuild-install/Test?label=test)](https://github.com/prebuild/prebuild-install/actions/workflows/test.yml)
+[![Standard](https://img.shields.io/badge/standard-informational?logo=javascript\&logoColor=fff)](https://standardjs.com)
+[![Common Changelog](https://common-changelog.org/badge.svg)](https://common-changelog.org)
+
+## Note
+
+**Instead of [`prebuild`](https://github.com/prebuild/prebuild) paired with [`prebuild-install`](https://github.com/prebuild/prebuild-install), we recommend [`prebuildify`](https://github.com/prebuild/prebuildify) paired with [`node-gyp-build`](https://github.com/prebuild/node-gyp-build).**
+
+With `prebuildify`, all prebuilt binaries are shipped inside the package that is published to npm, which means there's no need for a separate download step like you find in `prebuild`. The irony of this approach is that it is faster to download all prebuilt binaries for every platform when they are bundled than it is to download a single prebuilt binary as an install script.
+
+Upsides:
+
+1. No extra download step, making it more reliable and faster to install.
+2. Supports changing runtime versions locally and using the same install between Node.js and Electron. Reinstalling or rebuilding is not necessary, as all prebuilt binaries are in the npm tarball and the correct one is simply picked on runtime.
+3. The `node-gyp-build` runtime dependency is dependency-free and will remain so out of principle, because introducing dependencies would negate the shorter install time.
+4. Prebuilt binaries work even if npm install scripts are disabled.
+5. The npm package checksum covers prebuilt binaries too.
+
+Downsides:
+
+1. The installed npm package is larger on disk. Using [Node-API](https://nodejs.org/api/n-api.html) alleviates this because Node-API binaries are runtime-agnostic and forward-compatible.
+2. Publishing is mildly more complicated, because `npm publish` must be done after compiling and fetching prebuilt binaries (typically in CI).
+
+## Usage
+
+Use [`prebuild`](https://github.com/prebuild/prebuild) to create and upload prebuilt binaries. Then change your package.json install script to:
+
+```json
+{
+  "scripts": {
+    "install": "prebuild-install || node-gyp rebuild"
+  }
+}
+```
+
+When a consumer then installs your package with npm thus triggering the above install script, `prebuild-install` will download a suitable prebuilt binary, or exit with a non-zero exit code if there is none, which triggers `node-gyp rebuild` in order to build from source.
+
+Options (see below) can be passed to `prebuild-install` like so:
+
+```json
+{
+  "scripts": {
+    "install": "prebuild-install -r napi || node-gyp rebuild"
+  }
+}
+```
+
+### Help
+
+```
+prebuild-install [options]
+
+  --download    -d  [url]       (download prebuilds, no url means github)
+  --target      -t  version     (version to install for)
+  --runtime     -r  runtime     (Node runtime [node, napi or electron] to build or install for, default is node)
+  --path        -p  path        (make a prebuild-install here)
+  --token       -T  gh-token    (github token for private repos)
+  --arch            arch        (target CPU architecture, see Node OS module docs, default is current arch)
+  --platform        platform    (target platform, see Node OS module docs, default is current platform)
+  --tag-prefix <prefix>         (github tag prefix, default is "v")
+  --build-from-source           (skip prebuild download)
+  --verbose                     (log verbosely)
+  --libc                        (use provided libc rather than system default)
+  --debug                       (set Debug or Release configuration)
+  --version                     (print prebuild-install version and exit)
+```
+
+When `prebuild-install` is run via an `npm` script, options `--build-from-source`, `--debug`, `--download`, `--target`, `--runtime`, `--arch` `--platform` and `--libc` may be passed through via arguments given to the `npm` command.
+
+Alternatively you can set environment variables `npm_config_build_from_source=true`, `npm_config_platform`, `npm_config_arch`, `npm_config_target` `npm_config_runtime` and `npm_config_libc`.
+
+### Libc
+
+On non-glibc Linux platforms, the Libc name is appended to platform name. For example, musl-based environments are called `linuxmusl`. If `--libc=glibc` is passed as option, glibc is discarded and platform is called as just `linux`. This can be used for example to build cross-platform packages on Alpine Linux.
+
+### Private Repositories
+
+`prebuild-install` supports downloading prebuilds from private GitHub repositories using the `-T <github-token>`:
+
+```
+$ prebuild-install -T <github-token>
+```
+
+If you don't want to use the token on cli you can put it in `~/.prebuild-installrc`:
+
+```
+token=<github-token>
+```
+
+Alternatively you can specify it in the `prebuild-install_token` environment variable.
+
+Note that using a GitHub token uses the API to resolve the correct release meaning that you are subject to the ([GitHub Rate Limit](https://developer.github.com/v3/rate_limit/)).
+
+### Create GitHub Token
+
+To create a token:
+
+- Go to [this page](https://github.com/settings/tokens)
+- Click the `Generate new token` button
+- Give the token a name and click the `Generate token` button, see below
+
+![prebuild-token](https://cloud.githubusercontent.com/assets/13285808/20844584/d0b85268-b8c0-11e6-8b08-2b19522165a9.png)
+
+The default scopes should be fine.
+
+### Custom binaries
+
+The end user can override binary download location through environment variables in their .npmrc file.
+The variable needs to meet the mask `% your package name %_binary_host` or `% your package name %_binary_host_mirror`. For example:
+
+```
+leveldown_binary_host=http://overriden-host.com/overriden-path
+```
+
+Note that the package version subpath and file name will still be appended.
+So if you are installing `leveldown@1.2.3` the resulting url will be:
+
+```
+http://overriden-host.com/overriden-path/v1.2.3/leveldown-v1.2.3-node-v57-win32-x64.tar.gz
+```
+
+#### Local prebuilds
+
+If you want to use prebuilds from your local filesystem, you can use the `% your package name %_local_prebuilds` .npmrc variable to set a path to the folder containing prebuilds. For example:
+
+```
+leveldown_local_prebuilds=/path/to/prebuilds
+```
+
+This option will look directly in that folder for bundles created with `prebuild`, for example:
+
+```
+/path/to/prebuilds/leveldown-v1.2.3-node-v57-win32-x64.tar.gz
+```
+
+Non-absolute paths resolve relative to the directory of the package invoking prebuild-install, e.g. for nested dependencies.
+
+### Cache
+
+All prebuilt binaries are cached to minimize traffic. So first `prebuild-install` picks binaries from the cache and if no binary could be found, it will be downloaded. Depending on the environment, the cache folder is determined in the following order:
+
+- `${npm_config_cache}/_prebuilds`
+- `${APP_DATA}/npm-cache/_prebuilds`
+- `${HOME}/.npm/_prebuilds`
+
+## Install
+
+With [npm](https://npmjs.org) do:
+
+```
+npm install prebuild-install
+```
+
+## License
+
+[MIT](./LICENSE)