Galerie und tage

node_modules/bin-build/readme.md

@@ -13,89 +13,55 @@ $ npm install --save bin-build
 ## Usage
 
 ```js
-const binBuild = require('bin-build');
+var BinBuild = require('bin-build');
 
-binBuild.url('http://www.lcdf.org/gifsicle/gifsicle-1.80.tar.gz', [
-	'./configure --disable-gifview --disable-gifdiff',
-	'make install'
-]).then(() => {
-	console.log('gifsicle built successfully');
-});
+var build = new BinBuild()
+    .src('http://www.lcdf.org/gifsicle/gifsicle-1.80.tar.gz')
+    .cmd('./configure --disable-gifview --disable-gifdiff')
+    .cmd('make install');
 
-binBuild.file('gifsicle-1.80.tar.gz', [
-	'./configure --disable-gifview --disable-gifdiff',
-	'make install'
-]).then(() => {
-	console.log('gifsicle built successfully');
+build.run(function (err) {
+    console.log('gifsicle built successfully');
 });
 ```
 
 
 ## API
 
-### binBuild.directory(directory, commands)
+### new BinBuild(options)
 
-#### directory
+Creates a new `BinBuild` instance.
 
-Type: `string`
+#### options.strip
 
-Path to a directory containing the source code.
-
-#### commands
-
-Type: `Array`
-
-Commands to run when building.
-
-### binBuild.file(file, commands, [options])
-
-#### file
-
-Type: `string`
-
-Path to a archive file containing the source code.
-
-#### commands
-
-Type: `Array`
-
-Commands to run when building.
-
-#### options
-
-Type: `Object`
-
-##### strip
-
-Type: `number`<br>
-Default: `1`
+Type: `number`
 
 Strip a number of leading paths from file names on extraction.
 
-### binBuild.url(url, commands, [options])
+### .src(str)
 
-#### url
+#### str
 
 Type: `string`
 
-URL to a archive file containing the source code.
+Accepts a URL to a archive containing the source code, a path to an archive or a 
+path to a directory containing the source code.
 
-#### commands
+### .cmd(str)
 
-Type: `Array`
+#### str
 
-Commands to run when building.
+Type: `string`
 
-#### options
+Add a command to run when building.
 
-Type: `Object`
+### .run(callback)
 
-##### strip
+#### callback(err)
 
-Type: `number`<br>
-Default: `1`
+Type: `function`
 
-Strip a number of leading paths from file names on extraction.
+Runs the build and returns an error if something has gone wrong
 
 
 ## License