push.rocks/smartcli
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
Phil Kunz 2015-10-14 21:09:26 +02:00
parent 9442f738d9
commit 9bb85ca666
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -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.
//returns true for terminal command "node yourjs.js jazz"
smartcli.checkCommand('jazz');
smartcli.getOption('myoption');
``
Cheers
Phil from Lossless Digital