Skip to content

Commit 8da969c

Browse files
committed
docs: add install guide
1 parent 93afd87 commit 8da969c

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,20 @@
22

33
Generate executable alias for Go build-time dependencies / third-party `go tool`. Inspired by Ruby Bundler's `bundle binstubs`.
44

5-
## Example
5+
## Install
66

77
```shellsession
8-
$ toolstub github.com/golangci/golangci-lint/cmd/golangci-lint
8+
# go run go.husin.dev/toolstub@latest -tool go.husin.dev/toolstub
99
```
1010

11-
And the generated output will be [a bash script wrapping `go` commands](bin/golangci-lint).
11+
## Usage
12+
13+
```shellsession
14+
# toolstub github.com/golangci/golangci-lint/cmd/golangci-lint
15+
```
16+
17+
And the generated output will be [a bash script in `bin/golangci-lint` wrapping various `go` commands](bin/golangci-lint).
18+
19+
Running the program is as boring as executing `bin/golangci-lint`. First run will be slower due to installation and subsequent runs will be instant.
20+
21+
The versioning and dependencies are tracked in `_tools/golangci-lint.go.{mod,sum}`, which can be tracked by dependency managers like Dependabot.

0 commit comments

Comments
 (0)