From c5ad36dd179c63517738cecaaf8474d8fd665a98 Mon Sep 17 00:00:00 2001
From: Tavian Barnes <tavianator@tavianator.com>
Date: Sun, 27 Mar 2022 13:44:43 -0400
Subject: README: Add a blurb about fancy errors/warnings

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index c68dd97..0ebac8f 100644
--- a/README.md
+++ b/README.md
@@ -88,6 +88,28 @@ $ <strong>bfs</strong> -L <em>haystack</em> -name 'needle'    │ $ <strong>find
 </pre>
 </details>
 
+<details>
+<summary><code>bfs</code> gives helpful errors and warnings.</summary>
+
+For example, `bfs` will detect and suggest corrections for typos:
+
+<pre>
+$ bfs -nam needle
+<strong>bfs: error:</strong> bfs <strong>-nam</strong> needle
+<strong>bfs: error:</strong>     <strong>~~~~</strong>
+<strong>bfs: error:</strong> Unknown argument; did you mean <strong>-name</strong>?
+</pre>
+
+`bfs` also includes a powerful static analysis to identify likely mistakes:
+
+<pre>
+$ bfs -print -name 'needle'
+<strong>bfs: warning:</strong> bfs -print <strong>-name needle</strong>
+<strong>bfs: warning:</strong>            <strong>~~~~~~~~~~~~</strong>
+<strong>bfs: warning:</strong> The result of this expression is ignored.
+</pre>
+</details>
+
 <details>
 <summary><code>bfs</code> adds some options that make common tasks easier.</summary>
 
-- 
cgit v1.2.3