Skip to content

Commit 528d164

Browse files
author
Brian Vaughn
committed
Added additional benchmark instructions
1 parent 63607f3 commit 528d164

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

benchmarks/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,27 @@ cd ./benchmarks
1313
yarn install
1414

1515
# Run a benchmark of your choice
16+
# eg Compare your local build of js-search to the latest released build
1617
node ./regression-test.js
1718
```
19+
20+
You can also compare two local builds of js-search:
21+
22+
```bash
23+
# Assumes you've frun `yarn install` in both directories prior
24+
25+
cd /path/to/js-search
26+
27+
# Make some changes and then build js-search
28+
npm run build
29+
30+
# Move your build into the benchmarks folder as the 'latest'
31+
cp -r ./dist ./benchmarks/node_modules/js-search/
32+
33+
# Make more changes and then re-build js-search
34+
npm run build
35+
36+
# Compare your most recent build to the previous one
37+
cd ./benchmarks
38+
node ./regression-test.js
39+
```

0 commit comments

Comments
 (0)