From 9bb85ca66606ca2fac3025b187edf7cc6c2486b7 Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Wed, 14 Oct 2015 21:09:26 +0200 Subject: [PATCH] updated readme --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 798ab10..d0274ba 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,13 @@ nodejs wrapper for CLI related tasks [![devDependency Status](https://david-dm.org/pushrocks/smartcli/dev-status.svg)](https://david-dm.org/pushrocks/smartcli#info=devDependencies) ### Usage -This npm package comes with everything you need to start your own gulp plugin. +```js -We recommend modifying the ts/index.ts file, -then run `npm install` to install the dev dependencies -and use `npm test` to compile the TypeScript file. - -Cheers +//returns true for terminal command "node yourjs.js jazz" +smartcli.checkCommand('jazz'); + +smartcli.getOption('myoption'); +`` + +Cheers Phil from Lossless Digital