Skip to content

Commit b9c37f2

Browse files
committed
add more info to readme
1 parent 74296ab commit b9c37f2

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
# GitHub Action for extraction and transformation of benchmark data
22

3+
GitHub Action to transform benchmark output into a standardized format, and write to a file.
4+
35
Currently supported sources:
46
- `cargo bench`
57
- `criterion`
68

79
## Fields
810
- `name` (required): name of the benchmark
11+
- `tool` (required): tool used to get benchmark output. One of `["cargo"]`
912
- `platform` (required): a string describing the platform
10-
- `output-file-path`: a path to a file containing the benchmark output
11-
- `data-out-path`: the path where the output of the action should be written
13+
- `output-file-path` (required): a path to a file containing the output of the benchmark tool
14+
- `data-out-path` (required): the path where the output of the action should be written

0 commit comments

Comments
 (0)