Skip to content

Commit

Permalink
chore: update readme with vitest
Browse files Browse the repository at this point in the history
  • Loading branch information
adriencaccia committed Nov 21, 2023
1 parent cb13748 commit e8372eb
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ GitHub Actions for running [CodSpeed](https://codspeed.io) in your CI.
## Python with `pytest` and [`pytest-codspeed`](https://github.com/CodSpeedHQ/pytest-codspeed)

This worfklow will run the benchmarks found in the `tests/` folder and upload the results to CodSpeed.
This workflow will run the benchmarks found in the `tests/` folder and upload the results to CodSpeed.

It will be triggered on every push to the `main` branch and on every pull request.

Expand Down Expand Up @@ -114,9 +114,9 @@ jobs:
token: ${{ secrets.CODSPEED_TOKEN }}
```
## Node.js with `codspeed-node` and TypeScript
## Node.js with `codspeed-node`, TypeScript and `vitest`

This workflow will run the benchmarks found in the `benches/bench.ts` file and upload the results to CodSpeed.
This workflow will run the benchmarks defined with `vitest`'s `bench` function and upload the results to CodSpeed.

It will be triggered on every push to the `main` branch and on every pull request.

Expand All @@ -143,6 +143,6 @@ jobs:
- name: Run benchmarks
uses: CodSpeedHQ/action@v1
with:
run: node -r esbuild-register benches/bench.ts
run: npx vitest bench
token: ${{ secrets.CODSPEED_TOKEN }}
```

0 comments on commit e8372eb

Please sign in to comment.