From 598f8a6b0a3c2ea0347e87f9fa83aae5c5c57883 Mon Sep 17 00:00:00 2001 From: Matteo Collina Date: Wed, 11 Dec 2024 08:52:31 +0100 Subject: [PATCH] Clarify what these benchmarks are for (#370) * Clarify what these benchmarks are for Signed-off-by: Matteo Collina * Update README.md Co-authored-by: Arthur Fiorette <47537704+arthurfiorette@users.noreply.github.com> Signed-off-by: Matteo Collina --------- Signed-off-by: Matteo Collina Signed-off-by: Matteo Collina Co-authored-by: Arthur Fiorette <47537704+arthurfiorette@users.noreply.github.com> --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index edd544b0..e523f611 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,8 @@ Disclosure](https://img.shields.io/badge/Security-Responsible%20Disclosure-yello # TL;DR * [Fastify](https://github.com/fastify/fastify) is a fast and low overhead web framework for Node.js. -* This package shows how fast it is comparatively. +* This package shows how fast it is compared to other JS frameworks: these benchmarks do not pretend to represent a real-world scenario, but they give a **good indication of the framework overhead**. +* The benchmarks are run automatically on GitHub actions, which means they run on virtual hardwardware that can suffer from the "noisy neighbor" effect; this means that the results can vary. * For metrics (cold-start) see [metrics.md](./METRICS.md) # Requirements