From 142af0cd4fe160c795534cf73a622a60a395b111 Mon Sep 17 00:00:00 2001
From: Brian Hicks <brian@brianthicks.com>
Date: Tue, 24 Aug 2021 15:05:08 -0500
Subject: [PATCH] add benchmarking

---
 BENCHMARKING.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 BENCHMARKING.md

diff --git a/BENCHMARKING.md b/BENCHMARKING.md
new file mode 100644
index 0000000..f17288b
--- /dev/null
+++ b/BENCHMARKING.md
@@ -0,0 +1,15 @@
+# Benchmarking
+
+This program started out life as a fairly simple Go program that just runs everything in a single thread.
+I'm rewriting it in Rust for learning, but also because I think Rayon might let me make this problem parallelizable!
+
+Here's an initial benchmark on a `/usr/share/dict/words` of 235,886 lines:
+
+```
+$ hyperfine './result/bin/similar-sort benchmark < /usr/share/dict/words'
+Benchmark #1: ./result/bin/similar-sort benchmark < /usr/share/dict/words
+  Time (mean ± σ):     307.4 ms ±   6.0 ms    [User: 273.5 ms, System: 75.5 ms]
+  Range (min … max):   298.3 ms … 317.2 ms    10 runs
+```
+
+Let's see if we can get any faster than that!