From f832605d813908c593803b16f8632a7b92ed4a5d Mon Sep 17 00:00:00 2001
From: Casey Rodarmor <casey@rodarmor.com>
Date: Tue, 26 May 2020 13:56:42 -0700
Subject: [PATCH] Document benchmarks in readme

type: documentation
---
 README.md                   | 13 +++++++++++++
 bin/gen/templates/README.md | 12 ++++++++++++
 2 files changed, 25 insertions(+)

diff --git a/README.md b/README.md
index 478236f..b8dfa4c 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,7 @@ For more about the project and its goals, check out
   - [Release Updates](#release-updates)
 - [Chat](#chat)
 - [Contributing](#contributing)
+- [Benchmarks](#benchmarks)
 - [Semantic Versioning](#semantic-versioning)
 - [Unstable Features](#unstable-features)
 - [Source Signatures](#source-signatures)
@@ -269,6 +270,18 @@ fixes:
 The only required field is `type`. To see the possible values for `type`, run
 `cargo run --package gen commit-types`.
 
+## Benchmarks
+
+Performance benchmarks can be run with:
+
+```shell
+$ cargo bench --features bench
+```
+
+The benchmark framework used is [`criterion`](https://github.com/bheisler/criterion.rs).
+
+The bench targets themselves are in the `benches` directory. These targets call benchmarking functions in `src/benches.rs`, which are only enabled when the `bench` feature is enabled.
+
 ## Semantic Versioning
 
 Intermodal follows [semantic versioning](https://semver.org/).
diff --git a/bin/gen/templates/README.md b/bin/gen/templates/README.md
index 1576cc5..1616336 100644
--- a/bin/gen/templates/README.md
+++ b/bin/gen/templates/README.md
@@ -245,6 +245,18 @@ fixes:
 The only required field is `type`. To see the possible values for `type`, run
 `cargo run --package gen commit-types`.
 
+## Benchmarks
+
+Performance benchmarks can be run with:
+
+```shell
+$ cargo bench --features bench
+```
+
+The benchmark framework used is [`criterion`](https://github.com/bheisler/criterion.rs).
+
+The bench targets themselves are in the `benches` directory. These targets call benchmarking functions in `src/benches.rs`, which are only enabled when the `bench` feature is enabled.
+
 ## Semantic Versioning
 
 Intermodal follows [semantic versioning](https://semver.org/).