Skip to content

Commit c8b0eeb

Browse files
Fix install docs: correct tap name, add binary download section, fix LSP link
- Homebrew tap command was wrong: amberframework/amber_cli -> amberframework/amber-cli (Homebrew convention: repo homebrew-<name> maps to tap amberframework/<name>). Formula name is amber-cli, so install command is `brew install amber-cli`. - Add "Direct Binary Download" section with curl + sha256 verification steps pointing at the GitHub releases page. - Fix LSP Setup Guide link: was pointing at personal fork github.com/crimson-knight/amber/blob/master/... — now points at the canonical org repo github.com/amberframework/amber/blob/v2-dev/... - Bump Crystal requirement from 1.0+ to 1.20+ to match shard.yml floor raised in #22 (Time.instant requires Crystal >= 1.20.0). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent ede1d18 commit c8b0eeb

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,28 @@ The comprehensive documentation includes detailed guides, examples, and API refe
1818

1919
**macOS & Linux via Homebrew:**
2020
```bash
21-
brew tap amberframework/amber_cli
22-
brew install amber_cli
21+
brew tap amberframework/amber-cli
22+
brew install amber-cli
23+
```
24+
25+
**Direct Binary Download (macOS ARM64 / Linux x86_64):**
26+
27+
Download the pre-built tarball from the [releases page](https://github.com/amberframework/amber_cli/releases) and verify the sha256 before extracting:
28+
29+
```bash
30+
# macOS ARM64 example — replace VERSION and PLATFORM as needed
31+
VERSION=2.0.1
32+
PLATFORM=darwin-arm64 # or linux-x86_64
33+
34+
curl -LO "https://github.com/amberframework/amber_cli/releases/download/v${VERSION}/amber_cli-${PLATFORM}.tar.gz"
35+
curl -LO "https://github.com/amberframework/amber_cli/releases/download/v${VERSION}/amber_cli-${PLATFORM}.tar.gz.sha256"
36+
37+
# Verify checksum (macOS: shasum -a 256; Linux: sha256sum)
38+
shasum -a 256 -c "amber_cli-${PLATFORM}.tar.gz.sha256"
39+
40+
# Extract and install
41+
tar -xzf "amber_cli-${PLATFORM}.tar.gz"
42+
sudo mv amber amber-lsp /usr/local/bin/
2343
```
2444

2545
**From Source:**
@@ -171,7 +191,7 @@ cd ~/open_source_coding_projects/amber_cli
171191
crystal build src/amber_lsp.cr -o bin/amber-lsp --release
172192
```
173193

174-
For full documentation on all 15 rules, configuration options, and custom rule syntax, see the [LSP Setup Guide](https://github.com/crimson-knight/amber/blob/master/docs/guides/lsp-setup.md).
194+
For full documentation on all 15 rules, configuration options, and custom rule syntax, see the [LSP Setup Guide](https://github.com/amberframework/amber/blob/v2-dev/docs/guides/lsp-setup.md).
175195

176196
## 📚 Examples
177197

@@ -251,7 +271,7 @@ We welcome contributions! Please read our [Contributing Guide](CONTRIBUTING.md)
251271

252272
## 📋 Requirements
253273

254-
- **Crystal** 1.0+ (latest stable recommended)
274+
- **Crystal** 1.20+ (latest stable recommended)
255275
- **Git** (for project templates)
256276
- **Database** (PostgreSQL, MySQL, or SQLite)
257277

0 commit comments

Comments
 (0)