From 979cb593167ce5dfb68a7d9b497f6b61d3639a63 Mon Sep 17 00:00:00 2001 From: Yar Kravtsov Date: Sat, 25 Jan 2025 18:58:22 +0200 Subject: [PATCH] docs(README): add comprehensive installation instructions for multiple platforms --- README.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) diff --git a/README.md b/README.md index fcc0dfe..1e93d98 100644 --- a/README.md +++ b/README.md @@ -34,10 +34,88 @@ Integration: ## Installation +Download the latest release from the [releases page](https://github.com/yarlson/zero/releases/latest). + +### macOS + +1. Download the appropriate archive for your system architecture: + + - For AMD64 (Intel): `zero_*_darwin_amd64.tar.gz` + - For ARM64 (Apple Silicon): `zero_*_darwin_arm64.tar.gz` + +2. Extract the binary: + + ```bash + tar xzf zero_*.tar.gz + ``` + +3. Make the binary executable and move it to your local bin directory: + + ```bash + chmod +x ./zero + sudo mv ./zero /usr/local/bin/ + ``` + +4. Remove the macOS security quarantine attribute: + ```bash + sudo xattr -d com.apple.quarantine /usr/local/bin/zero + ``` + +### Linux + +1. Download the appropriate archive for your system architecture: + + - For AMD64: `zero_*_linux_amd64.tar.gz` + - For ARM64: `zero_*_linux_arm64.tar.gz` + +2. Extract the binary: + + ```bash + tar xzf zero_*.tar.gz + ``` + +3. Make the binary executable and move it to your local bin directory: + ```bash + chmod +x ./zero + sudo mv ./zero /usr/local/bin/ + ``` + +### Windows + +1. Download the appropriate archive for your system architecture: + + - For Windows AMD64: `zero_*_windows_amd64.tar.gz` + - For Windows ARM64: `zero_*_windows_arm64.tar.gz` + +2. Extract the archive using your preferred archive tool + +3. Add the extracted binary location to your system's PATH environment variable + +### From Source + +If you have Go 1.23 or later installed: + ```bash go install github.com/yarlson/zero@latest ``` +### Using Docker + +Pull and run the latest image: + +```bash +docker pull yarlson/zero:latest +``` + +See the [Docker](#docker) section for detailed usage instructions. + +### Verify Installation + +To verify the installation: +```bash +zero --help +``` + ## Usage Basic usage: