1- # bin-wrapper [ ![ Build Status ] ( https://travis-ci.org /kevva/bin-wrapper. svg?branch=master )] ( https://travis-ci.org /kevva/bin-wrapper )
1+ # bin-wrapper [ ![ CI ] ( https://github.com /kevva/bin-wrapper/actions/workflows/ci.yml/badge. svg )] ( https://github.com /kevva/bin-wrapper/actions/workflows/ci.yml )
22
33> Binary wrapper that makes your programs seamlessly available as local dependencies
44
55
66## Install
77
8- ```
9- $ npm install bin-wrapper
8+ ``` sh
9+ npm install bin-wrapper
1010```
1111
1212
@@ -15,7 +15,7 @@ $ npm install bin-wrapper
1515``` js
1616const BinWrapper = require (' bin-wrapper' );
1717
18- const base = ' https://github.com/imagemin/gifsicle-bin/raw/master /vendor' ;
18+ const base = ' https://github.com/imagemin/gifsicle-bin/raw/main /vendor' ;
1919const bin = new BinWrapper ()
2020 .src (` ${ base} /macos/gifsicle` , ' darwin' )
2121 .src (` ${ base} /linux/x64/gifsicle` , ' linux' , ' x64' )
@@ -50,15 +50,15 @@ Type: `Object`
5050
5151##### skipCheck
5252
53- Type: ` boolean ` < br >
54- Default: ` false `
53+ * Type: ` boolean `
54+ * Default: ` false `
5555
5656Whether to skip the binary check or not.
5757
5858##### strip
5959
60- Type: ` number ` < br >
61- Default: ` 1 `
60+ * Type: ` number `
61+ * Default: ` 1 `
6262
6363Strip a number of leading paths from file names on extraction.
6464
@@ -110,7 +110,7 @@ Returns the full path to your binary.
110110
111111Type: ` string `
112112
113- Define a [ semver range] ( https://github.com/isaacs /node-semver#ranges ) to check
113+ Define a [ semver range] ( https://github.com/npm /node-semver#ranges ) to check
114114the binary against.
115115
116116### .run([ arguments] )
@@ -120,8 +120,8 @@ using the URL provided in `.src()`.
120120
121121#### arguments
122122
123- Type: ` Array ` < br >
124- Default: ` ['--version'] `
123+ * Type: ` Array `
124+ * Default: ` ['--version'] `
125125
126126Command to run the binary with. If it exits with code ` 0 ` it means that the
127127binary is working.
0 commit comments