README-template.md

[NAME]

Description of project goes here.

Installation

First, if you have not done so already, install Homebrew:

$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Next, install Node.js:

$ brew install node
# Tip! Run this on a regular basis:
$ brew doctor && brew update && brew upgrade && brew cleanup && brew prune && brew doctor

Once the above steps are complete, and your system is happy …

Install [NAME] via npm

$ npm i [NPM] -g

Alternative installation options; putting here as reminders, feel free to remove the ones you are not using:

GitHub, public repo

$ npm i [USER]/[REPO] -g

GitHub, private repo

$ npm i git+https://token:[email protected]/[USER]/[REPO].git#master -g
# … or:
$ npm i git+ssh://[email protected]/[USER]/[REPO].git#master -g

Bitbucket, public repo

$ npm i git+ssh://[email protected]/[USER]/[REPO].git#master -g

Bitbucket, private repo

$ npm i git+https://username:[email protected]/[USER]/[REPO].git#master -g
# … or:
$ npm i git+ssh://[email protected]/[USER]/[REPO].git#master -g

Usage

Activate in current directory:

$ cd to/a/directory/
$ [COMMAND] -d .

… or, specify path to a directory:

$ [COMMAND] -d to/a/directory/

Get help:

$ [COMMAND] -h