bench: Add readme.

1 files changed, 27 insertions, 0 deletions

diff --git a/openpgp/benches/README.md b/openpgp/benches/README.md
new file mode 100644
index 00000000..38418da7
--- /dev/null
+++ b/openpgp/benches/README.md
@@ -0,0 +1,27 @@
+# Benchmarks
+
+We use [`criterion`](https://crates.io/crates/criterion) as a benchmark framework. It is
+* statistics driven,
+* configurable,
+* produces nice plots
+* and is compatible with stable Rust.
+
+To run the benchmarks, run
+```
+cargo bench
+```
+
+To run a specific benchmark, run
+```
+cargo bench -- benchmark_name
+```
+
+To test the benchmarks, run
+```
+cargo test --benches
+```
+
+To test a specific benchmark
+```
+cargo test --benches -- benchmark_name
+```