From ec092c8a303125198d9a658c6cb39666b3c963b6 Mon Sep 17 00:00:00 2001
From: Joshua Lampert <joshua.lampert@uni-hamburg.de>
Date: Tue, 29 Oct 2024 10:58:45 +0100
Subject: [PATCH] add README

---
 benchmark/README.md | 6 ++++++
 1 file changed, 6 insertions(+)
 create mode 100644 benchmark/README.md

diff --git a/benchmark/README.md b/benchmark/README.md
new file mode 100644
index 00000000..ce56105b
--- /dev/null
+++ b/benchmark/README.md
@@ -0,0 +1,6 @@
+# Benchmarks
+
+This directory contains some benchmark setups using [BenchmarkTools.jl](https://github.com/JuliaCI/BenchmarkTools.jl).
+The file `benchmarks.jl` is run by a GitHub Action leveraging [AirspeedVelocity.jl](https://github.com/MilesCranmer/AirspeedVelocity.jl)
+to generate a report on the performance of the package for each pull request. If you want to run the benchmarks locally, you can do so by running
+`run_benchmarks.jl`, which returns a summary `results` of the benchmark results.