cli-argument-parser - npm Package Compare versions

Comparing version 0.2.8 to 0.2.9

package.json

		{
		"name": "cli-argument-parser",
		"version": "0.2.8",
		"version": "0.2.9",
		"description": "A package containing relevant CLI actions",
		@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

		@@ -1,13 +0,24 @@
		# Command-line Argument Parser · [![GitHub license](https://img.shields.io/badge/license-BSD%203%20Clause-blue.svg)](https://github.com/danitseitlin/cli-argument-parser/blob/master/LICENSE) [![npm version](http://img.shields.io/npm/v/cli-argument-parser.svg?style=flat)](https://npmjs.org/package/cli-argument-parser "View this project on npm") ![CI](https://github.com/danitseitlin/cli-argument-parser/workflows/CI/badge.svg)
		## About
		This NodeJS module is built for easier working with command line arguments.
		## Quick Start
		<p align='center'><a href='https://github.com/danitseitlin/cli-argument-parser'><img src='.github/resources/logo.png' /></a></p>

		### Install the module
		Run the following command in your terminal:
		<p align='center'>
		<a href='https://github.com/danitseitlin/cli-argument-parser/blob/master/LICENSE'>
		<img src='https://img.shields.io/badge/license-BSD%203%20Clause-blue.svg' target='_blank' />
		</a>
		<a href='https://npmjs.org/package/cli-argument-parser'>
		<img src='http://img.shields.io/npm/v/cli-argument-parser.svg?style=flat' target='_blank' />
		</a>
		<a href='https://npmjs.org/package/cli-argument-parser' style='width:25px;height:20px;'>
		<img src='https://img.shields.io/npm/dm/cli-argument-parser.svg?color=blue' target='_blank' />
		</a>
		<a href='https://npmjs.org/package/cli-argument-parser' style='width:25px;height:20px;'>
		<img src='https://img.shields.io/bitbucket/issues/danitseitlin/cli-argument-parser' target='_blank' />
		</a>
		</p>

		`npm i cli-argument-parser`
		<p align='center'><a href='https://github.com/danitseitlin/cli-argument-parser'><img src='.github/resources/gif.gif' /></a></p>

		## How to use
		### Basic usage
		## :metal: Quick Start
		Run `npm i cli-argument-parser`

		## :ok_hand: Basic usage
		```
		@@ -18,7 +29,6 @@ import { cliArguments } from 'cli-argument-parser';
		```
		Run a cli with `arg1` and `arg2`
		like: `my-command --arg1=2 --arg2=1`
		Run a cli with `arg1` and `arg2`, ie: `my-command --arg1=2 --arg2=1`
		And the values will be inside the variables we declared above.

		### Configuration file usage
		## :speak_no_evil: Easily configurate unique CLI's
		Create a file in the root of your project called `cli.config.json`
		@@ -34,2 +44,2 @@ and paste the following into it:
		The `seperator` is a value which seperated between the argument name and argument value. `=` is the default one. (ex: `--arg=5`) <br>
		This gives you the abillity to configurate your cli arguments as you wish.
		This gives you the abillity to configurate your cli arguments as you wish.

cli-argument-parser - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics