From f8fbc9b3af3ffb68edd1fdc2c892bf8f10e3141c Mon Sep 17 00:00:00 2001
From: chainchad <96362174+chainchad@users.noreply.github.com>
Date: Fri, 22 Nov 2024 17:28:00 -0500
Subject: [PATCH] Fix README

---
 tools/gomod-required-updater/README.md | 54 +++-----------------------
 1 file changed, 6 insertions(+), 48 deletions(-)

diff --git a/tools/gomod-required-updater/README.md b/tools/gomod-required-updater/README.md
index 24679131966..4e7fddc5f8c 100644
--- a/tools/gomod-required-updater/README.md
+++ b/tools/gomod-required-updater/README.md
@@ -2,72 +2,30 @@
 
 Updates required module versions in go.mod files to match the latest git SHA from a remote branch.
 
-## Features
-
-- Auto-detect and update modules with local replace directives
-- Preview changes with dry run mode
-
 ## Configuration
 
-Optional TOML config.
-
-```toml
-# List of modules to update
-modules = [
-    "github.com/smartcontractkit/chainlink/v2"
-]
-```
-
 Command Line Flags:
 
 ```shell
 Optional:
+  -org-name         Organization name to update modules for (default: smartcontractkit)
+  -repo-name        Repository name to update modules for (default: chainlink)
   -repo-remote      Git remote to use (default: origin)
   -branch-trunk     Branch to get SHA from (default: develop)
   -dry-run         Preview changes without applying them (default: false)
+  -
 ```
 
 ## Installation
 
-The installed binary will be placed in your `$GOPATH/bin` directory. Make sure this directory is in your system's PATH to run the command from anywhere.
+The installed binary will be placed in your `$GOPATH/bin` directory. Make sure this directory is in your system's PATH to run the command from anywhere. From the root of this repository, run:
 
 ```shell
-go install github.com/smartcontractkit/chainlink/tools/gomod-required-updater
+go install ./tools/gomod-required-updater/cmd/gomod-required-updater
 ```
 
 ## Usage Examples
 
-Update Specific Modules:
-
-```shell
-# Update single module
-gomod-required-updater -module github.com/org/repo`
-
-# Update multiple modules
-gomod-required-updater -module github.com/org/repo1 -module github.com/org/repo2
-
-# Update using config file
-gomod-required-updater -config modules.toml
-
-# Using different remote/branch
-gomod-required-updater -module github.com/org/repo -repo-remote upstream -branch-trunk main
-```
-
-Auto-detect and Update Local Modules:
-
 ```shell
-# Update all local modules that have replace directives
-gomod-required-updater -update-org-modules
-
-# Preview changes first
-gomod-required-updater -update-org-modules -dry-run
+make gomodrequiredupdater
 ```
-
-## Notes
-
-- When using multiple module sources, precedence is:
-  1. Command line `-module` flags
-  2. Config file modules
-  3. Auto-detected modules via `-update-org-modules` flag
-- Use the `-dry-run` flag to safely preview changes
-- Local replace directives are preserved during updates