From c15264b76361812c480462f94ba1bbea74761490 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Mon, 10 Sep 2018 07:40:50 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 80 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 62 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index e14c0fa..70751d4 100644 --- a/README.md +++ b/README.md @@ -2,27 +2,14 @@ | Sponsored by [ppl](https://ppl.family) | -Automated node.js installers for OS X and Ubuntu +Automated node.js installers for macOS and Linux -**node.js only** (no dev tools) +## QuickStart + +**node.js only** ```bash -# install node.js without development dependencies -curl -fsSL https://bit.ly/node-installer | bash -s -- --no-dev-deps - -# using wget instead of curl (Ubuntu) -wget -nv https://bit.ly/node-installer -O - | bash -s -- --no-dev-deps -``` - -**node.js + dev tools** - -Install node.js and basic development tools - git, node, gcc, pkg-config, etc - -```bash -curl -fsSL https://bit.ly/node-installer -o ./node-installer.sh; bash ./node-installer.sh --dev-deps - -# or wget -wget -nv https://bit.ly/node-installer -O - ./node-installer.sh; bash ./node-installer.sh --dev-deps +curl -fsSL https://bit.ly/node-installer | bash ``` *Note*: [bit.ly/node-installer](https://bit.ly/node-installer) simple redirects to @@ -33,6 +20,63 @@ wget -nv https://bit.ly/node-installer -O - ./node-installer.sh; bash ./node-ins ## Options +* [x] version +* [x] install location +* [x] tools for building native modules + +**Version Examples** + +By default the latest version will be installed. + +A specific version can be defined: + +```bash +NODE_VERSION=v10 # Latest of v10 +NODE_VERSION=v10.1 # Latest of v10.1 +NODE_VERSION=v10.10 # Latest of v10.10 +NODE_VERSION=v10.10.0 # Exactly v10.10.0 +``` + +``` +export NODE_VERSION=v10 +curl -fsSL https://bit.ly/node-installer | bash +``` + +**Custom Install Location** + +By default node will be installed to `/usr/local`, without root if possible. + +A custom location can be defined: + +``` +export NPM_CONFIG_PREFIX=$HOME/.local/ +export NODE_PATH=$HOME/.local/ +curl -fsSL https://bit.ly/node-installer | bash +``` + +## Node + Dev Tools + +* [x] curl & wget +* [x] rsync +* [x] gcc (via XCode or build-essential) +* [x] pkg-config +* [x] node.js +* [x] jshint + +Install node.js and basic development tools - git, node, gcc, pkg-config, etc + +```bash +curl -fsSL https://bit.ly/node-installer -o ./node-installer.sh; bash ./node-installer.sh --dev-deps + +``` + +Or with `wget` +```bash +wget -nv https://bit.ly/node-installer -O - ./node-installer.sh; bash ./node-installer.sh --dev-deps +``` + +## Options + ### Choosing a specific version **Latest**