From a33196d0d8cb0f58ef5f32a7a8b8f56a862d69af Mon Sep 17 00:00:00 2001
From: Ed Page <epage@duosecurity.com>
Date: Fri, 28 May 2021 18:37:01 -0500
Subject: [PATCH] docs: Add debugging steps

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

diff --git a/README.md b/README.md
index ab44225..926044d 100644
--- a/README.md
+++ b/README.md
@@ -89,5 +89,21 @@ typos dir/file --diff
 typos dir/file --format json
 ```
 
+### Debugging
+
+You can see what the effective config looks like by running
+```bash
+typos --dump-config -
+```
+
+You can then see how typos is processing your project with
+```bash
+typos --files
+typos --identifiers
+typos -- words
+```
+
+If you need to dig in more, you can enable debug logging with `-v`
+
 [Crates.io]: https://crates.io/crates/typos-cli
 [Documentation]: https://docs.rs/typos