Skip to content

Commit 50911b0

Browse files
committed
chore: update readmes
1 parent b22974e commit 50911b0

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

packages/benchmark.js-plugin/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ Benchmark.js compatibility layer for CodSpeed
1212

1313
## Documentation
1414

15-
Check out the [documentation](https://docs.codspeed.io/benchmarks/nodejs) for complete integration instructions.
15+
Check out the [documentation](https://docs.codspeed.io/benchmarks/nodejs/benchmark.js) for complete integration instructions.
1616

1717
## Installation
1818

19-
First install the plugin [`@codspeed/benchmark.js-plugin`](https://www.npmjs.com/package/@codspeed/tinybench-plugin) and `benchmark.js` (if not already installed):
19+
First, install the plugin [`@codspeed/benchmark.js-plugin`](https://www.npmjs.com/package/@codspeed/benchmark.js-plugin) and `benchmark.js` (if not already installed):
2020

2121
```sh
2222
npm install --save-dev @codspeed/benchmark.js-plugin benchmark.js
@@ -83,4 +83,4 @@ fibonacci15 x 194,742 ops/sec ±0.48% (95 runs sampled)
8383

8484
And... Congrats🎉, CodSpeed is installed in your benchmarking suite! Locally, CodSpeed will fallback to tinybench since the instrumentation is only available in the CI environment for now.
8585

86-
You can now [run those benchmark in your CI](https://docs.codspeed.io/benchmarks/nodejs#running-the-benchmarks-in-your-ci) to continuously get consistent performance measurements.
86+
You can now [run those benchmarks in your CI](https://docs.codspeed.io/benchmarks/nodejs/benchmark.js#running-the-benchmarks-in-your-ci) to continuously get consistent performance measurements.

packages/tinybench-plugin/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ tinybench compatibility layer for CodSpeed
1212

1313
## Documentation
1414

15-
Check out the [documentation](https://docs.codspeed.io/benchmarks/nodejs) for complete integration instructions.
15+
Check out the [documentation](https://docs.codspeed.io/benchmarks/nodejs/tinybench) for complete integration instructions.
1616

1717
## Installation
1818

19-
First install the plugin [`@codspeed/tinybench-plugin`](https://www.npmjs.com/package/@codspeed/tinybench-plugin) and `tinybench` (if not already installed):
19+
First, install the plugin [`@codspeed/tinybench-plugin`](https://www.npmjs.com/package/@codspeed/tinybench-plugin) and `tinybench` (if not already installed):
2020

2121
```sh
2222
npm install --save-dev @codspeed/tinybench-plugin tinybench
@@ -87,4 +87,4 @@ $ node benches/bench.mjs
8787

8888
And... Congrats🎉, CodSpeed is installed in your benchmarking suite! Locally, CodSpeed will fallback to tinybench since the instrumentation is only available in the CI environment for now.
8989

90-
You can now [run those benchmark in your CI](https://docs.codspeed.io/benchmarks/nodejs#running-the-benchmarks-in-your-ci) to continuously get consistent performance measurements.
90+
You can now [run those benchmarks in your CI](https://docs.codspeed.io/benchmarks/nodejs/tinybench#running-the-benchmarks-in-your-ci) to continuously get consistent performance measurements.

packages/vitest-plugin/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212

1313
## Documentation
1414

15-
Check out the [documentation](https://docs.codspeed.io/benchmarks/nodejs) for complete integration instructions.
15+
Check out the [documentation](https://docs.codspeed.io/benchmarks/nodejs/vitest) for complete integration instructions.
1616

1717
## Installation
1818

19-
First install the plugin [`@codspeed/vitest-plugin`](https://www.npmjs.com/package/@codspeed/vitest-plugin) and `vitest` (if not already installed):
19+
First, install the plugin [`@codspeed/vitest-plugin`](https://www.npmjs.com/package/@codspeed/vitest-plugin) and `vitest` (if not already installed):
2020

2121
> [!WARNING]
2222
> The CodSpeed plugin is only compatible with
@@ -87,4 +87,4 @@ $ pnpm vitest bench --run
8787

8888
And... Congrats 🎉, CodSpeed is installed in your benchmarking suite! Locally, CodSpeed will fallback to vitest since the instrumentation is only available in the CI environment for now.
8989

90-
You can now [run those benchmarks in your CI](https://docs.codspeed.io/benchmarks/nodejs#running-the-benchmarks-in-your-ci) to continuously get consistent performance measurements.
90+
You can now [run those benchmarks in your CI](https://docs.codspeed.io/benchmarks/nodejs/vitest#running-the-benchmarks-in-your-ci) to continuously get consistent performance measurements.

0 commit comments

Comments
 (0)