Compare commits

...

4 Commits

Author SHA1 Message Date
b1565dec3e 0.0.9 2015-10-14 21:14:29 +02:00
f6969ecfd5 improved readme 2015-10-14 21:14:20 +02:00
9bb85ca666 updated readme 2015-10-14 21:09:26 +02:00
9442f738d9 added devStatus badge 2015-10-14 21:01:39 +02:00
2 changed files with 24 additions and 9 deletions

View File

@ -1,16 +1,31 @@
# smartcli # smartcli
nodejs wrapper for CLI related tasks nodejs wrapper for CLI related tasks
[![Dev Status](https://img.shields.io/badge/DevStatus-Active-green.svg)](https://github.com/pushrocks/smartcli/commits/dev)
### Buildstatus/Dependencies ### Buildstatus/Dependencies
[![Build Status](https://travis-ci.org/pushrocks/smartcli.svg?branch=master)](https://travis-ci.org/pushrocks/smartcli) [![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) [![devDependency Status](https://david-dm.org/pushrocks/smartcli/dev-status.svg)](https://david-dm.org/pushrocks/smartcli#info=devDependencies)
### Usage ### Install the package
This npm package comes with everything you need to start your own gulp plugin. npm install smartcli
We recommend modifying the ts/index.ts file, ### Usage
then run `npm install` to install the dev dependencies ```js
and use `npm test` to compile the TypeScript file. var smartcli = require("smartcli");
Cheers //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');
``
Cheers
Phil from Lossless Digital Phil from Lossless Digital

View File

@ -1,6 +1,6 @@
{ {
"name": "smartcli", "name": "smartcli",
"version": "0.0.8", "version": "0.0.9",
"description": "nodejs wrapper for CLI related tasks", "description": "nodejs wrapper for CLI related tasks",
"main": "index.js", "main": "index.js",
"scripts": { "scripts": {