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

improved readme

Browse Source
This commit is contained in:
Phil Kunz
2015-10-14 21:14:20 +02:00
parent 9bb85ca666
commit f6969ecfd5
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -6,12 +6,24 @@ nodejs wrapper for CLI related tasks
[![Build Status](https://travis-ci.org/pushrocks/smartcli.svg?branch=master)](https://travis-ci.org/pushrocks/smartcli)
[![devDependency Status](https://david-dm.org/pushrocks/smartcli/dev-status.svg)](https://david-dm.org/pushrocks/smartcli#info=devDependencies)
### Install the package
npm install smartcli
### Usage
```js
var smartcli = require("smartcli");
//returns true for terminal command "node yourjs.js jazz"
//returns true for terminal command "node myjs.js jazz"
smartcli.checkCommand('jazz');
/**
* returns an object for terminal command "node myjs.js --myoption something like so
* {
* name: 'myoption',
* specified: true,
* value: 'something'
* }
*/
smartcli.getOption('myoption');
``