docs: Update README with `go install` installation instructions
This commit is contained in:
parent
f17c54a840
commit
d2c064abda
12
README.md
12
README.md
|
@ -18,16 +18,10 @@ A recursive link checker that crawls websites to find broken links and redirects
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
1. Make sure you have Go installed (version 1.16 or later)
|
Make sure you have Go installed (version 1.16 or later), then run:
|
||||||
2. Clone this repository:
|
|
||||||
```bash
|
|
||||||
git clone <repository-url>
|
|
||||||
cd link-checker
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Install dependencies:
|
|
||||||
```bash
|
```bash
|
||||||
go mod download
|
go install forgejo.ewintr.nl/ewintr/linkchecker@latest
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
@ -35,7 +29,7 @@ go mod download
|
||||||
Run the link checker by providing a starting URL:
|
Run the link checker by providing a starting URL:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
go run . -url="https://example.com"
|
linkchecker -url="https://example.com"
|
||||||
```
|
```
|
||||||
|
|
||||||
The tool will:
|
The tool will:
|
||||||
|
|
Loading…
Reference in New Issue