Clarify what these benchmarks are for (#370)

* Clarify what these benchmarks are for Signed-off-by: Matteo Collina <[email protected]> * Update README.md Co-authored-by: Arthur Fiorette <[email protected]> Signed-off-by: Matteo Collina <[email protected]> --------- Signed-off-by: Matteo Collina <[email protected]> Signed-off-by: Matteo Collina <[email protected]> Co-authored-by: Arthur Fiorette <[email protected]>
fastify · Dec 11, 2024 · 598f8a6 · 598f8a6
1 parent 95bb329
commit 598f8a6
Showing 1 changed file with 2 additions and 1 deletion.
diff --git 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