Skip to content

Commit

Permalink
Update the readme and package version
Browse files Browse the repository at this point in the history
  • Loading branch information
nazarhussain committed Jan 10, 2025
1 parent 80d3b92 commit cf5d852
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Benchmark

> This is an independently maintained fork of [@dapplion/benchmark](https://github.com/dapplion/benchmark).
This repo now maintains it's own versioning as `@chainsafe/benchmark` and release schedule. It was forked from the base of `@dapplion/[email protected]` and new functionality was added.

Ensures that new code does not introduce performance regressions with CI. Tracks:

- Do PR against the base branch include a performance regression?
Expand All @@ -12,7 +15,7 @@ This tooling provides both a easy to use runner for benchmarking and easy integr
Create a benchmark test file but use `itBench` instead of `it`

```ts
import {itBench, setBenchOpts, describe} from "../../src";
import {describe, itBench, setBenchOpts} from "@chainsafe/benchmark";

describe("Sum array benchmark", () => {
itBench("sum array with reduce", () => {
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "@dapplion/benchmark",
"version": "1.0.0",
"repository": "[email protected]:dapplion/benchmark.git",
"author": "dapplion <[email protected]>",
"name": "@chainsafe/benchmark",
"version": "1.1.0.rc-0",
"repository": "[email protected]:chainsafe/benchmark.git",
"author": "ChainSafe Systems",
"license": "MIT",
"bin": {
"benchmark": "./bin/index.js"
Expand Down

0 comments on commit cf5d852

Please sign in to comment.