Skip to content

Commit

Permalink
docs(README): add comprehensive installation instructions for multipl…
Browse files Browse the repository at this point in the history
…e platforms
  • Loading branch information
yarlson committed Jan 25, 2025
1 parent 7106dab commit 979cb59
Showing 1 changed file with 78 additions and 0 deletions.
78 changes: 78 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 979cb59

Please sign in to comment.