diff --git a/README.md b/README.md index b28e8d9..c46526d 100644 --- a/README.md +++ b/README.md @@ -104,17 +104,37 @@ curl http://localhost:8000/api/v1/health ### 2. Install the client -Build from source: +**From a release** (recommended): + +Check [releases](https://gitea.dcglab.co.uk/steve/kb/releases) for the latest client tag, then: + +```bash +# Set the version tag +TAG=client-v2.1.0 + +# Linux (amd64) +curl -L -o kb https://gitea.dcglab.co.uk/steve/kb/releases/download/${TAG}/kb-linux-amd64 + +# Linux (arm64) +curl -L -o kb https://gitea.dcglab.co.uk/steve/kb/releases/download/${TAG}/kb-linux-arm64 + +# macOS (Apple Silicon) +curl -L -o kb https://gitea.dcglab.co.uk/steve/kb/releases/download/${TAG}/kb-darwin-arm64 + +# macOS (Intel) +curl -L -o kb https://gitea.dcglab.co.uk/steve/kb/releases/download/${TAG}/kb-darwin-amd64 + +# Then install +chmod +x kb +sudo mv kb /usr/local/bin/ +``` + +**From source** (for development): ```bash cd client make build # produces ./kb binary -``` - -Or cross-compile for all platforms: - -```bash -make all # produces dist/kb-{os}-{arch} binaries +make all # or cross-compile: dist/kb-{os}-{arch} ``` ### 3. Configure the client