From 6ac75b2897ddf2f010c57818094377cd7c7ffc36 Mon Sep 17 00:00:00 2001 From: levithomason Date: Mon, 2 May 2016 21:27:39 -0700 Subject: [PATCH] docs(install): add install to readme --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4f11056..f303f60 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,18 @@ commands, providing an easy solution for simple Unix-like, cross-platform commands in npm package scripts. -## Example +## Install +```shell +npm install shx --save-dev +``` +This will allow using `shx` in your `package.json` scripts. + +## Usage + +### Command Line + +If you'd like to use `shx` on the command line, install it globally with the `-g` flag. The following code can be run *either a Unix or Windows* command line: ```Bash @@ -43,7 +53,7 @@ $ shx rm -r sub # options work as well All commands internally call the ShellJS corresponding function, guaranteeing cross-platform compatibility. -## Advantages over ShellJS +### package.json ShellJS is good for writing long scripts. If you want to write bash-like, platform-independent scripts, we recommend you go with that.