Skip to content

Commit e720c5a

Browse files
UlisesGascondougwilson
authored andcommitted
docs: add documentation for benchmarks
closes #5312
1 parent 3abea7f commit e720c5a

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

Diff for: benchmarks/README.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Express Benchmarks
2+
3+
## Installation
4+
5+
You will need to install [wrk](https://github.com/wg/wrk/blob/master/INSTALL) in order to run the benchmarks.
6+
7+
## Running
8+
9+
To run the benchmarks, first install the dependencies `npm i`, then run `make`
10+
11+
The output will look something like this:
12+
13+
```
14+
50 connections
15+
1 middleware
16+
7.15ms
17+
6784.01
18+
19+
[...redacted...]
20+
21+
1000 connections
22+
10 middleware
23+
139.21ms
24+
6155.19
25+
26+
```
27+
28+
### Tip: Include Node.js version in output
29+
30+
You can use `make && node -v` to include the node.js version in the output.
31+
32+
### Tip: Save the results to a file
33+
34+
You can use `make > results.log` to save the results to a file `results.log`.

0 commit comments

Comments
 (0)