csvalidate - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "csvalidate",
   "description": "test",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "author": "@vitormalencar",
@@ -6,0 +6,0 @@ "bin": {

README.md

@@ -1,16 +0,47 @@
-mycli
-=====
+<img width="100%" src="./Artwork.png" alt="A simple and flexible CLI to validatote CSV schemas">
 
-test
+> A simple flexible SUPER FAST  and lightweight CLI to validatote CSV schemas
 
 [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
-[![Version](https://img.shields.io/npm/v/mycli.svg)](https://npmjs.org/package/mycli)
-[![Downloads/week](https://img.shields.io/npm/dw/mycli.svg)](https://npmjs.org/package/mycli)
-[![License](https://img.shields.io/npm/l/mycli.svg)](https://github.com/vitormalencar/mycli/blob/master/package.json)
+[![Version](https://img.shields.io/npm/v/csvalidate.svg)](https://npmjs.org/package/csvalidate)
+[![Downloads/week](https://img.shields.io/npm/dw/csvalidate.svg)](https://www.npmjs.com/package/csvalidate)
+[![License](https://img.shields.io/npm/l/csvalidate.svg)](https://github.com/vitormalencar/csvalidate/blob/master/package.json)
 
+## Why it's awesome
+Comming soon
+
 <!-- toc -->
+* [Install](#install)
 * [Usage](#usage)
 * [Commands](#commands)
 <!-- tocstop -->
+
+# Install
+
+**Install globally with npm**
+
+```sh
+npm i -g csvalidate
+```
+
+**Install with npm**
+
+```sh
+npm i csvalidate
+```
+
+**Install with Yarn**
+
+```sh
+yarn global add csvalidate
+```
+
+**Run with npx (without installing)**
+
+```sh
+npx csvalidate
+```
+
 # Usage
+
 <!-- usage -->
@@ -22,3 +53,3 @@ ```sh-session
 $ csvalidate (-v|--version|version)
-csvalidate/0.0.1 darwin-x64 node-v12.14.1
+csvalidate/0.0.2 darwin-x64 node-v12.14.1
 $ csvalidate --help [COMMAND]
@@ -30,5 +61,27 @@ USAGE
 <!-- usagestop -->
+
 # Commands
-<!-- commands -->
 
-<!-- commandsstop -->
+```sh
+ Usage:
+
+  csvalidate [PATH] [RULES]
+
+ Options:
+
+  -h, --help              Display help information
+  -v, --version           Output csvalidate version
+  -p, --path=path         Path to CSV  file
+  -r, --rules=path        Path to rules file
+
+ Examples:
+
+  csvalidate data.csv
+
+  csvalidate -p data.csv  -r .rules.json
+
+  csvalidate --path data.csv --rules .rules.json
+
+ Default settings with no arguments:
+
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9035

increased by10.75%

Number of lines in readme file

86

increased by160.61%

No dependency changes