Skip to content

Commit 9df3c82

Browse files
committed
Add instructions for running benchmarks
1 parent 04c291a commit 9df3c82

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,16 @@
11
# WordPress Cache Benchmarks
2+
3+
## Running Benchmarks
4+
5+
Running the benchmarks requires installing
6+
[Nix](https://docs.determinate.systems/determinate-nix/#getting-started).
7+
You can enter a development shell via `nix develop`,
8+
or automatically using [direnv](https://direnv.net/).
9+
10+
After starting a development shell,
11+
you can run the benchmarks via `just bench`.
12+
This runs a series of 500 random requests using each
13+
plugin and each backend that that plugin supports.
14+
15+
You can run specific benchmarks via `just bench -c <name>`.
16+
See `finefile --help` for a full list of options.

0 commit comments

Comments
 (0)