From 51dfd6f7bcdd7b4ae9825210d61fb17a742ae76e Mon Sep 17 00:00:00 2001
From: Riccardo Mazzarini <me@noib3.dev>
Date: Mon, 27 Nov 2023 23:10:55 +0100
Subject: [PATCH] add `Performance` section to the README

---
 README.md  |  7 +++++++
 src/lib.rs | 20 ++++++++++++++++++--
 2 files changed, 25 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 8fbcbce..0ee23f0 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,13 @@ sometimes referred to as "string similarity search", or more colloquially
 - `FzfV2`: port of the algorithm used by fzf when launching without any extra
   flags or with `--algo=v2`;
 
+## Performance
+
+Performance is a top priority for this crate. Our goal is to have the fastest
+implementation of every metric algorithm we provide, across all languages.
+[Here][bench] you can find a number of benchmarks comparing norm's metrics to
+each other, as well as to other popular libraries.
+
 ## Example usage
 
 ```rust
diff --git a/src/lib.rs b/src/lib.rs
index 90f73b8..4ae3112 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -39,13 +39,29 @@
 //!     .filter_map(|city| fzf.distance(query, city).map(|dist| (city, dist)))
 //!     .collect::<Vec<_>>();
 //!
-//! // We sort the results by distance in ascending order. The closest
-//! // match will be at the front of the list.
+//! // We sort the results by distance in ascending order, so that the best match
+//! // will be at the front of the vector.
 //! results.sort_by_key(|(_city, dist)| *dist);
 //!
 //! assert_eq!(results.len(), 2);
 //! assert_eq!(results[0].0, "Adelaide");
 //! assert_eq!(results[1].0, "Ulaanbaatar");
+//!
+//! // We can also find out which sub-strings of each candidate matched the
+//! // query.
+//!
+//! let mut ranges = Vec::new();
+//!
+//! let _ = fzf.distance_and_ranges(query, results[0].0, &mut ranges);
+//! assert_eq!(ranges.len(), 2);
+//! assert_eq!(ranges[0], 0..1); // "A" in "Adelaide"
+//! assert_eq!(ranges[1], 4..5); // "a" in "Adelaide"
+//!
+//! ranges.clear();
+//!
+//! let _ = fzf.distance_and_ranges(query, results[1].0, &mut ranges);
+//! assert_eq!(ranges.len(), 1);
+//! assert_eq!(ranges[0], 2..4); // The first "aa" in "Ulaanbaatar"
 //! ```
 //!
 //! # Features flags