download - npm Package Compare versions

Comparing version 4.0.1-rc.1 to 4.0.1

cli.js

@@ -6,3 +6,2 @@ #!/usr/bin/env node
 var meow = require('meow');
-var progress = require('download-status');
 var stdin = require('get-stdin');
@@ -9,0 +8,0 @@

package.json

 {
   "name": "download",
-  "version": "4.0.1-rc.1",
+  "version": "4.0.1",
   "description": "Download and extract files effortlessly",
@@ -5,0 +5,0 @@ "license": "MIT",

readme.md

@@ -19,3 +19,3 @@ # download [![Build Status](http://img.shields.io/travis/kevva/download.svg?style=flat)](https://travis-ci.org/kevva/download)
 
-var download = new Download({ extract: true, strip: 1, mode: '755' })
+var download = new Download({extract: true, strip: 1, mode: '755'})
 	.get('http://example.com/foo.zip')
@@ -40,52 +40,61 @@ .get('http://example.com/cat.jpg')
 
-### .get(url, [dest])
+#### opts.extract
 
-Type: `String`
+Type: `Boolean`  
+Default: `false`
 
-Add a file to download.
+If set to `true`, try extracting the file using [decompress](https://github.com/kevva/decompress/).
 
-### .dest(dir)
+#### opts.mode
 
-Type: `String`
+Type: `String`  
 
-Set the destination folder to where your files will be downloaded.
+Set mode on the downloaded file, i.e `{mode: '755'}`.
 
-### .rename(name)
+#### opts.strip
 
-Type: `Function|String`
+Type: `Number`  
+Default: `0`
 
-Rename your files using [gulp-rename](https://github.com/hparra/gulp-rename).
+Equivalent to `--strip-components` for tar.
 
-### .run(cb)
+### .get(url, [dest])
 
-Type: `Function`
+#### url
 
-Downloads your files and returns an error if something has gone wrong.
+Type: `String`
 
-#### cb(err, files)
+Add a URL to download.
 
-The callback will return an array of vinyl files.
+#### dest
 
-## Options
+Type: `String`
 
-### extract
+Set an optional destination folder that will take precedence over the one set in 
+`.dest()`.
 
-Type: `Boolean`  
-Default: `false`
+### .dest(dir)
 
-If set to `true`, try extracting the file using [decompress](https://github.com/kevva/decompress/).
+#### dir
 
-### mode
+Type: `String`
 
-Type: `String`  
+Set the destination folder to where your files will be downloaded.
 
-Set mode on the downloaded file, i.e `{ mode: '755' }`.
+### .rename(name)
 
-### strip
+#### name
 
-Type: `Number`  
-Default: `0`
+Type: `Function|String`
 
-Equivalent to `--strip-components` for tar.
+Rename your files using [gulp-rename](https://github.com/hparra/gulp-rename).
 
+### .run(cb)
+
+#### cb(err, files)
+
+Type: `Function`
+
+The callback will return an array of vinyl files.
+
 ## CLI
@@ -92,0 +101,0 @@

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9209

increased by0.36%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

128

increased by7.56%

Worsened metrics

Lines of code

229

decreased by-0.43%

No dependency changes