ewintr
/
linkchecker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Update README with `go install` installation instructions

This commit is contained in:
Erik Winter (aider) 2024-11-25 10:23:50 +01:00
parent f17c54a840
commit d2c064abda
1 changed files with 3 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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 <repository-url>
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: