Skip to content

Commit

Permalink
feat: initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
rluvaton committed Sep 29, 2023
1 parent 22587af commit f95920e
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# `node-bisect`
# `node-bisect` - Find node release that introduced a regression

Find node release that introduced a regression
[![npm](https://img.shields.io/npm/v/node-bisect)](https://www.npmjs.com/package/node-bisect)

> Note: if you are on mac you can provide `--source docker` to run the tests in docker container (on other platforms docker is used by default)
Run `npm start -- --help` to see all available options

Run `npx node-bisect --help` to see all available options

### Example

Expand All @@ -26,5 +27,5 @@ source.text().finally(() => {

Run this command to find the release that introduced the regression
```bash
npm start -- --from 18.17.0 --to 20.5.0 --test ./test.cjs
npx node-bisect --from 18.17.0 --to 20.5.0 --test ./test.cjs
```

0 comments on commit f95920e

Please sign in to comment.