Benchmarks and performance enhancements (#209)

[poolifier.git] / benchmarks / versus-external-pools / README.md

diff --git a/benchmarks/versus-external-pools/README.md b/benchmarks/versus-external-pools/README.md
new file mode 100644 (file)
index 0000000..02ba1a6
--- /dev/null
+++ b/benchmarks/versus-external-pools/README.md
@@ -0,0 +1,7 @@
+# Poolifier Benchmarks
+
+To run the benchmark versus other pools you will need to:
+
+- [Install hyperfine](https://github.com/sharkdp/hyperfine#installation)
+- Run `npm install`
+- Run the `./bench.sh` into the `versus-external-pools` folder