diff options
Diffstat (limited to 'website/README.md')
-rw-r--r-- | website/README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/website/README.md b/website/README.md new file mode 100644 index 000000000..dece0c7ff --- /dev/null +++ b/website/README.md @@ -0,0 +1,23 @@ +## About benchmark data + +The benchmark chart supposes `//website/data.json` has the signature of `BenchmarkData[]` where `BenchmarkData` is defined like the below: + +```typescript +interface ExecTimeData { + mean: number + stddev: number + user: number + system: number + min: number + max: number +} + +interface BenchmarkData { + created_at: string, + sha1: string, + binary_size?: number, + benchmark: { + [key: string]: ExecTimeData + } +} +``` |