Skip to content

Commit

Permalink
doc: add bench-node-cli mention
Browse files Browse the repository at this point in the history
I wrote this tool to allow users run their benchmark
without having to install bench-node explicitly.
  • Loading branch information
RafaelGSS committed Nov 16, 2024
1 parent be8ec69 commit 5012269
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,13 @@ Using delete property x 3,326,913 ops/sec (11 runs sampled) v8-never-optimize=tr
This module uses V8 deoptimization to help ensure that the code block is not optimized away, producing accurate benchmarks -- but not realistic.
See the [Writing JavaScript Microbenchmark Mistakes](#TODO) section for more details.

The [`bench-node-cli`](https://github.com/RafaelGSS/bench-node-cli) tool allows you to execute a `bench-node` benchmark
from any location, eliminating the need to install the `bench-node` package locally.
Simply use the following command to run your benchmark:

```bash
npx bench-node-cli my-benchmark.js
```
See the [examples folder](./examples/) for more common usage examples.

## Table of Contents
Expand Down

0 comments on commit 5012269

Please sign in to comment.