From d2c064abda1f31394627b066646b431256ab7649 Mon Sep 17 00:00:00 2001 From: "Erik Winter (aider)" Date: Mon, 25 Nov 2024 10:23:50 +0100 Subject: [PATCH] docs: Update README with `go install` installation instructions --- README.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 50c5f13..3e7cf7b 100644 --- a/README.md +++ b/README.md @@ -18,16 +18,10 @@ A recursive link checker that crawls websites to find broken links and redirects ## Installation -1. Make sure you have Go installed (version 1.16 or later) -2. Clone this repository: -```bash -git clone -cd link-checker -``` +Make sure you have Go installed (version 1.16 or later), then run: -3. Install dependencies: ```bash -go mod download +go install forgejo.ewintr.nl/ewintr/linkchecker@latest ``` ## Usage @@ -35,7 +29,7 @@ go mod download Run the link checker by providing a starting URL: ```bash -go run . -url="https://example.com" +linkchecker -url="https://example.com" ``` The tool will: