Skip to content

Commit 774646e

Browse files
committed
docs: add Homebrew install as primary method, remove duplicate install sections
1 parent 25292ad commit 774646e

1 file changed

Lines changed: 6 additions & 37 deletions

File tree

README.md

Lines changed: 6 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,19 @@ A terminal-based user interface for browsing Hacker News with Vim-style navigati
66

77
## Quickstart
88

9-
### Install Rust
10-
11-
Install Rust by going here and following the instructions: [https://www.rust-lang.org/tools/install](https://www.rust-lang.org/tools/install)
12-
13-
### Install Hackertuah
14-
15-
Install and run immediately with Cargo:
9+
### Homebrew (recommended)
1610

1711
```bash
18-
git clone https://github.com/program247365/hackertuah.git
19-
cd hackertuah
20-
cargo run --release
12+
brew tap program247365/tap
13+
brew install hackertuah
2114
```
2215

23-
Or install globally from the latest source:
16+
### Cargo
2417

2518
```bash
2619
cargo install --git https://github.com/program247365/hackertuah
2720
```
2821

29-
Now you can call it on your commandline:
30-
31-
```bash
32-
hackertuah
33-
```
34-
3522
## Features
3623

3724
- **Browse** top Hacker News stories in your terminal across Top, Ask, Show, and Jobs sections
@@ -102,36 +89,18 @@ Press `o` to open the options menu:
10289

10390
## Installation
10491

105-
### Cargo
106-
107-
```bash
108-
cargo install --git https://github.com/program247365/hackertuah
109-
```
110-
11192
### Prerequisites
11293

113-
- Rust and Cargo (Latest stable version)
114-
- A Claude API key from Anthropic (for summarization feature)
94+
- A Claude API key from Anthropic (for the summarization feature)
11595

11696
### Setup
11797

118-
1. Clone the repository:
119-
```bash
120-
git clone https://github.com/program247365/hackertuah
121-
cd hackertuah
122-
```
98+
Add your Claude API key to your environment:
12399

124-
2. Add your Claude API key to your environment:
125100
```bash
126101
export CLAUDE_API_KEY=your_key_here
127102
```
128103

129-
3. Build and run:
130-
```bash
131-
cargo build --release
132-
cargo run
133-
```
134-
135104
## Project Structure
136105

137106
```

0 commit comments

Comments
 (0)