From 51dfeaa0cd40bb9119527d2367193e8ee781f39a Mon Sep 17 00:00:00 2001
From: Alexandre Terrasa <alexandre.terrasa@shopify.com>
Date: Fri, 1 Mar 2024 12:13:17 -0500
Subject: [PATCH] Add some documentation

Signed-off-by: Alexandre Terrasa <alexandre.terrasa@shopify.com>
---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 6a61d4ed..7ad300c1 100644
--- a/README.md
+++ b/README.md
@@ -359,6 +359,22 @@ require "spoom/backtrace_filter/minitest"
 Minitest.backtrace_filter = Spoom::BacktraceFilter::Minitest.new
 ```
 
+### Dead code removal
+
+Run dead code detection in your project with:
+
+```
+$ spoom deadcode
+```
+
+This will list all the methods and constants that do not appear to be used in your project.
+
+You can remove them with Spoom:
+
+```
+$ spoom deadcode remove path/to/file.rb:42:18-47:23
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Don't forget to run `bin/sanity` before pushing your changes.