Skip to content

Commit bade79a

Browse files
authored
feat: add Homebrew tap and installation instructions (#7)
- Create Homebrew tap at greysquirr3l/homebrew-shadowforge - Add Homebrew installation to README (brew tap + install) - Add binary download instructions with example - Update Homebrew docs with tap repo link and status - Update formula template version example to 0.7.6 Users can now install with: brew tap greysquirr3l/shadowforge brew install shadowforge
1 parent 20ee3b6 commit bade79a

File tree

3 files changed

+46
-5
lines changed

3 files changed

+46
-5
lines changed

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -235,13 +235,37 @@ Complete documentation available in [`docs/public/cli/`](docs/public/cli/):
235235
**Status**: CLI application is fully functional with 7 production-ready steganography
236236
techniques and all 4 distribution patterns.
237237

238-
### Prerequisites
238+
### Homebrew (macOS/Linux)
239239

240-
- Go 1.21 or higher
241-
- Git
240+
```bash
241+
brew tap greysquirr3l/shadowforge
242+
brew install shadowforge
243+
```
244+
245+
### Download Binary
246+
247+
Download pre-built binaries from [GitHub Releases](https://github.com/greysquirr3l/shadowforge/releases/latest):
248+
249+
- macOS (Intel): `shadowforge_*_darwin_amd64.tar.gz`
250+
- macOS (Apple Silicon): `shadowforge_*_darwin_arm64.tar.gz`
251+
- Linux (x64): `shadowforge_*_linux_amd64.tar.gz`
252+
- Linux (ARM64): `shadowforge_*_linux_arm64.tar.gz`
253+
254+
```bash
255+
# Example: Install on macOS Apple Silicon
256+
VERSION=0.7.6
257+
curl -L -O https://github.com/greysquirr3l/shadowforge/releases/download/v${VERSION}/shadowforge_${VERSION}_darwin_arm64.tar.gz
258+
tar -xzf shadowforge_${VERSION}_darwin_arm64.tar.gz
259+
sudo mv shadowforge_${VERSION}_darwin_arm64/shadowforge /usr/local/bin/
260+
shadowforge version
261+
```
242262

243263
### From Source
244264

265+
**Prerequisites**: Go 1.21 or higher, Git
266+
267+
### Build from Source
268+
245269
```bash
246270
# Clone the repository
247271
git clone https://github.com/greysquirr3l/shadowforge.git

docs/homebrew/README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
11
# Homebrew Distribution (shadowforge)
22

3-
This project is a CLI tool, so Homebrew distribution should use a **formula** (not a cask).
3+
**Status**: Homebrew tap is live at [greysquirr3l/homebrew-shadowforge](https://github.com/greysquirr3l/homebrew-shadowforge)
4+
5+
This project is a CLI tool, so Homebrew distribution uses a **formula** (not a cask).
6+
7+
## User Installation
8+
9+
Users can install shadowforge via Homebrew:
10+
11+
```bash
12+
brew tap greysquirr3l/shadowforge
13+
brew install shadowforge
14+
```
15+
16+
## Tap Repository
17+
18+
The tap lives at: https://github.com/greysquirr3l/homebrew-shadowforge
19+
20+
Formula location: `Formula/shadowforge.rb`
421

522
## Release Assets
623

docs/homebrew/shadowforge.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ class Shadowforge < Formula
1313
license "Apache-2.0"
1414

1515
# Example:
16-
# version "0.6.0"
16+
# version "0.7.6"
1717
version "0.0.0"
1818

1919
on_macos do

0 commit comments

Comments
 (0)