summaryrefslogtreecommitdiff
path: root/benches
diff options
context:
space:
mode:
Diffstat (limited to 'benches')
-rw-r--r--benches/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/benches/README.md b/benches/README.md
new file mode 100644
index 0000000..6ed8cc5
--- /dev/null
+++ b/benches/README.md
@@ -0,0 +1,13 @@
+# Benchmark results
+
+Coming soon.
+
+# Benchmarking
+
+Benchmarks are run using [Criterion.rs](https://github.com/bheisler/criterion.rs) and can be found in the `benches` directory.
+
+## Running benchmarks
+
+```sh
+$ cargo bench --bench <name>
+```