Skip to content

Commit ca82719

Browse files
committed
doc: Update readme
1 parent 63b53b1 commit ca82719

File tree

1 file changed

+33
-25
lines changed

1 file changed

+33
-25
lines changed

README.md

Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -28,31 +28,39 @@ cargo install apisnip
2828

2929
### Pre-built Binaries
3030

31-
Pre-built binary packages are available in the [GitHub releases](https://github.com/Tuurlijk/apisnip/releases). Each release includes a variety of package formats for different platforms:
32-
33-
- **Linux**: `.deb`, `.rpm`, `.AppImage` (x86_64 only), and `.tar.gz` archives
34-
- **macOS**: `.dmg` and `.tar.gz` archives
35-
- **Windows**: `.msi` installers and `.zip` archives
36-
37-
We support a wide range of architectures:
38-
- x86_64 (64-bit Intel/AMD)
39-
- aarch64/arm64 (64-bit ARM)
40-
- armv7 (32-bit ARM v7)
41-
- arm (32-bit ARM)
42-
- i686/i386 (32-bit Intel/AMD)
43-
- RISC-V 64-bit
44-
- x86_64 with MUSL libc
45-
46-
To download and use a pre-built binary:
47-
48-
1. Visit the [latest release page](https://github.com/Tuurlijk/apisnip/releases/latest)
49-
2. Download the appropriate package for your platform
50-
3. Install using your platform's standard method:
51-
- Linux: Use your package manager with `.deb`/`.rpm` or run the `.AppImage`
52-
- macOS: Open the `.dmg` and drag to Applications
53-
- Windows: Run the `.msi` installer
54-
55-
If you prefer not to use installers, the `.tar.gz` and `.zip` archives contain standalone binaries.
31+
Pre-built binaries and packages are available on the [GitHub releases](https://github.com/Tuurlijk/apisnip/releases) page for multiple platforms and architectures:
32+
33+
#### Binary Archives
34+
- **Linux**: x86_64, ARM (32/64-bit), RISC-V, PowerPC, s390x, and MUSL variants
35+
- **Windows**: 32-bit and 64-bit zip archives
36+
- **macOS**: Intel and Apple Silicon (ARM64) builds
37+
- **FreeBSD**: x86_64 builds
38+
39+
#### Package Formats
40+
- **Debian/Ubuntu**: Native `.deb` packages
41+
- **Red Hat/Fedora/SUSE**: RPM packages
42+
- **Arch Linux**: AUR package
43+
- **macOS**: Homebrew formula and DMG disk image
44+
- **Nix**: Package for NixOS and Nix package manager
45+
46+
Each release includes SHA256 checksums for verifying file integrity.
47+
48+
#### Quick Installation
49+
50+
```bash
51+
# Linux x86_64 example
52+
curl -L https://github.com/Tuurlijk/apisnip/releases/download/[version]/apisnip-linux-x86_64.tar.gz | tar xz
53+
./apisnip
54+
55+
# Or install using your system's package manager
56+
# Debian/Ubuntu
57+
sudo dpkg -i apisnip_[version]_amd64.deb
58+
59+
# Homebrew (macOS)
60+
brew install apisnip
61+
```
62+
63+
Replace `[version]` with the desired release version (e.g., `v1.4.56`).
5664

5765
## 📖 Usage
5866

0 commit comments

Comments
 (0)