Skip to content

Commit 4ac7427

Browse files
authored
Update install instructions (#152)
1 parent 4cf5181 commit 4ac7427

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -94,24 +94,33 @@ For client auto-discovery/configuration, a supported client:
9494

9595
### Installation
9696

97-
Installation is quite easy and we have several options to do so.
97+
ToolHive is a CLI tool written in Go and packaged as a single binary. You can
98+
install it using one of the following methods:
9899

99-
#### MacOS (Homebrew)
100+
#### Download the binary <!-- omit in toc -->
101+
102+
Download the latest cross-platform release binaries from
103+
[toolhive/releases](https://github.com/StacklokLabs/toolhive/releases).
104+
105+
#### Homebrew (macOS) <!-- omit in toc -->
106+
107+
Install on macOS using Homebrew:
100108

101109
```bash
102110
brew tap stacklok/tap
103111
brew install thv
104112
```
105113

106-
#### Download a release
114+
#### Build from source <!-- omit in toc -->
107115

108-
Download the latest release from [toolhive/releases](https://github.com/StacklokLabs/toolhive/releases).
116+
To build ToolHive from source, clone this repository and build the CLI using Go:
109117

110-
#### Build from source
111-
112-
You can do your normal `go build` and `go install`
118+
```bash
119+
go build ./cmd/thv
120+
go install ./cmd/thv
121+
```
113122

114-
or you can do the following if you have task installed (it's similar to `make`)
123+
Or using [Task](https://taskfile.dev/installation):
115124

116125
```bash
117126
task build

0 commit comments

Comments
 (0)