chore: brought back benchmark doc on readme

Tochemey · Aug 25, 2024 · 5cf2b24 · 5cf2b24
1 parent 7369b9c
commit 5cf2b24
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -63,6 +63,7 @@ The project adheres to [Semantic Versioning](https://semver.org) and [Convention
     - [Static Provider Setup](#static-provider-setup)
 - [Contribution](#contribution)
   - [Test \& Linter](#test--linter)
+- [Benchmark](#benchmark)
 
 ## Design Principles
 
@@ -626,3 +627,10 @@ Prior to submitting a [pull request](https://help.github.com/articles/using-pull
 ```bash
 earthly +test
 ```
+
+## Benchmark
+
+One can run the benchmark test from the [bench package](./bench):
+
+- `make bench` to run the benchmark
+- `make bench-stats` to see the benchmark stats