Skip to content

Commit

Permalink
Switch to GitHub Actions CI and tweak README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
XhmikosR committed Jan 12, 2022
1 parent 569681b commit 44dca3d
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 16 deletions.
35 changes: 35 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: CI

on:
push:
pull_request:
workflow_dispatch:

env:
FORCE_COLOR: 2

jobs:
test:
name: Node ${{ matrix.node }} on ${{ matrix.os }}
runs-on: ${{ matrix.os }}

strategy:
fail-fast: false
matrix:
node: [6, 8, 10, 12, 14, 16]
os: [ubuntu-latest, windows-latest]

steps:
- name: Clone repository
uses: actions/checkout@v2

- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node }}

- name: Install npm dependencies
run: npm install

- name: Run tests
run: npm test
5 changes: 0 additions & 5 deletions .travis.yml

This file was deleted.

22 changes: 11 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# bin-wrapper [![Build Status](https://travis-ci.org/kevva/bin-wrapper.svg?branch=master)](https://travis-ci.org/kevva/bin-wrapper)
# 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)

> Binary wrapper that makes your programs seamlessly available as local dependencies

## Install

```
$ npm install bin-wrapper
```sh
npm install bin-wrapper
```


Expand All @@ -15,7 +15,7 @@ $ npm install bin-wrapper
```js
const BinWrapper = require('bin-wrapper');

const base = 'https://github.com/imagemin/gifsicle-bin/raw/master/vendor';
const base = 'https://github.com/imagemin/gifsicle-bin/raw/main/vendor';
const bin = new BinWrapper()
.src(`${base}/macos/gifsicle`, 'darwin')
.src(`${base}/linux/x64/gifsicle`, 'linux', 'x64')
Expand Down Expand Up @@ -50,15 +50,15 @@ Type: `Object`

##### skipCheck

Type: `boolean`<br>
Default: `false`
* Type: `boolean`
* Default: `false`

Whether to skip the binary check or not.

##### strip

Type: `number`<br>
Default: `1`
* Type: `number`
* Default: `1`

Strip a number of leading paths from file names on extraction.

Expand Down Expand Up @@ -110,7 +110,7 @@ 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/npm/node-semver#ranges) to check
the binary against.

### .run([arguments])
Expand All @@ -120,8 +120,8 @@ using the URL provided in `.src()`.

#### arguments

Type: `Array`<br>
Default: `['--version']`
* Type: `Array`
* Default: `['--version']`

Command to run the binary with. If it exits with code `0` it means that the
binary is working.
Expand Down

0 comments on commit 44dca3d

Please sign in to comment.