From c8ededa9112393c19a4c2dd377a9a2663acb9831 Mon Sep 17 00:00:00 2001
From: cryptodev-2s <109512101+cryptodev-2s@users.noreply.github.com>
Date: Tue, 19 Dec 2023 13:38:53 +0100
Subject: [PATCH] Add changelog update usage for package rename options in
 README (#184)

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

diff --git a/README.md b/README.md
index 1c223e3..43db5b6 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,18 @@ or
 
 `npm run auto-changelog update --rc`
 
+#### Update the changelog for a renamed package
+
+This option is designed to be used for packages that live in a monorepo.
+
+For instance, if your package is called `polling-controller` and was renamed to `@metamask/polling-controller` at version 0.2.3, and thus the Git tags followed suit:
+
+`yarn run auto-changelog update --tag-prefix-before-package-rename "polling-controller@" --version-before-package-name 0.2.3 --tag-prefix "@metamask/polling-controller@"`
+
+or
+
+`npm run auto-changelog update --tag-prefix-before-package-rename "polling-controller@" --version-before-package-name 0.2.3 --tag-prefix "@metamask/polling-controller@"`
+
 ### Validate
 
 #### Validate the changelog simply