Galerie und tage

node_modules/bin-wrapper/readme.md

@@ -1,4 +1,4 @@
-# bin-wrapper [![Build Status](https://travis-ci.org/kevva/bin-wrapper.svg?branch=master)](https://travis-ci.org/kevva/bin-wrapper)
+# bin-wrapper [![Build Status](http://img.shields.io/travis/kevva/bin-wrapper.svg?style=flat)](https://travis-ci.org/kevva/bin-wrapper)
 
 > Binary wrapper that makes your programs seamlessly available as local dependencies
 
@@ -6,58 +6,52 @@
 ## Install
 
 ```
-$ npm install bin-wrapper
+$ npm install --save bin-wrapper
 ```
 
 
 ## Usage
 
 ```js
-const BinWrapper = require('bin-wrapper');
+var BinWrapper = require('bin-wrapper');
 
-const base = 'https://github.com/imagemin/gifsicle-bin/raw/master/vendor';
-const bin = new BinWrapper()
-	.src(`${base}/macos/gifsicle`, 'darwin')
-	.src(`${base}/linux/x64/gifsicle`, 'linux', 'x64')
-	.src(`${base}/win/x64/gifsicle.exe`, 'win32', 'x64')
+var base = 'https://github.com/imagemin/gifsicle-bin/raw/master/vendor';
+var bin = new BinWrapper()
+	.src(base + '/osx/gifsicle', 'darwin')
+	.src(base + '/linux/x64/gifsicle', 'linux', 'x64')
+	.src(base + '/win/x64/gifsicle.exe', 'win32', 'x64')
 	.dest(path.join('vendor'))
 	.use(process.platform === 'win32' ? 'gifsicle.exe' : 'gifsicle')
 	.version('>=1.71');
 
-(async () => {
-	await bin.run(['--version']);
+bin.run(['--version'], function (err) {
 	console.log('gifsicle is working');
-})();
+});
 ```
 
 Get the path to your binary with `bin.path()`:
 
 ```js
-console.log(bin.path());
-//=> 'path/to/vendor/gifsicle'
+console.log(bin.path()); // => path/to/vendor/gifsicle
 ```
 
 
 ## API
 
-### `new BinWrapper(options)`
+### new BinWrapper(options)
 
 Creates a new `BinWrapper` instance.
 
-#### options
+#### options.skipCheck
 
-Type: `Object`
-
-##### skipCheck
-
-Type: `boolean`<br>
+Type: `boolean`  
 Default: `false`
 
 Whether to skip the binary check or not.
 
-##### strip
+#### options.strip
 
-Type: `number`<br>
+Type: `number`  
 Default: `1`
 
 Strip a number of leading paths from file names on extraction.
@@ -84,17 +78,17 @@ Type: `string`
 
 Tie the source to a specific arch.
 
-### .dest(destination)
+### .dest(dest)
 
-#### destination
+#### dest
 
 Type: `string`
 
 Accepts a path which the files will be downloaded to.
 
-### .use(binary)
+### .use(bin)
 
-#### binary
+#### bin
 
 Type: `string`
 
@@ -110,22 +104,28 @@ Returns the full path to your binary.
 
 Type: `string`
 
-Define a [semver range](https://github.com/isaacs/node-semver#ranges) to check
+Define a [semver range](https://github.com/isaacs/node-semver#ranges) to check 
 the binary against.
 
-### .run([arguments])
+### .run([cmd], callback)
 
-Runs the search for the binary. If no binary is found it will download the file
+Runs the search for the binary. If no binary is found it will download the file 
 using the URL provided in `.src()`.
 
-#### arguments
+#### cmd
 
-Type: `Array`<br>
+Type: `array`  
 Default: `['--version']`
 
-Command to run the binary with. If it exits with code `0` it means that the
+Command to run the binary with. If it exits with code `0` it means that the 
 binary is working.
 
+#### callback(err)
+
+Type: `function`
+
+Returns nothing but a possible error.
+
 
 ## License