From 562b02d06118a28990c46772bac877466c303dd8 Mon Sep 17 00:00:00 2001 From: ehmicky Date: Sun, 25 Aug 2019 16:59:48 +0200 Subject: [PATCH] Update README --- README.md | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 8f8934c..a782fca 100644 --- a/README.md +++ b/README.md @@ -119,19 +119,26 @@ You can either: and retrieve its exit `code` or `signal` - use the [`childProcess`](https://nodejs.org/api/child_process.html#child_process_class_childprocess) - if you want to to access its output. Please note `options.stdio` defaults to - `inherit`. + if you want to to access its output. Please note + [`options.stdio`](https://nodejs.org/api/child_process.html#child_process_options_stdio) + defaults to `inherit`. ## Initial download The first time `nve` is run with a new `VERSION`, the Node binary is downloaded -from [`nodejs.org`](https://nodejs.org/dist/) under the hood. This initially -takes few seconds. However subsequent runs are +from [`https://nodejs.org/dist`](https://nodejs.org/dist/) under the hood. This +initially takes few seconds. However subsequent runs are [almost instantaneous](#benchmarks). A spinner will show the download progress. This can be disabled using the environment variable `NVE_PROGRESS=0`. +You can specify a mirror website using the environment variable `NODE_MIRROR`. + +```bash +NODE_MIRROR="https://npm.taobao.org/mirrors/node" nve VERSION [ARGS...] +``` + ## Native modules If your code is using native modules, `nve` will work providing: @@ -143,16 +150,6 @@ If your code is using native modules, `nve` will work providing: Otherwise the following error message will be shown: `Error: The module was compiled against a different Node.js version`. -## Node.js mirror - -The binaries are downloaded from -[https://nodejs.org/dist](https://nodejs.org/dist). You can specify a mirror -website using the environment variable `NODE_MIRROR`. - -```bash -NODE_MIRROR="https://npm.taobao.org/mirrors/node" nve VERSION [ARGS...] -``` - # API (Node.js) ## nve(versionRange, args?, options?)