Skip to content

Commit 437ea97

Browse files
committed
docs: Update readme with latest features.
1 parent a200136 commit 437ea97

File tree

1 file changed

+50
-17
lines changed

1 file changed

+50
-17
lines changed

README.md

Lines changed: 50 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,56 @@ cargo install --git https://github.com/program247365/hackertuah
2222

2323
## Features
2424

25-
- 🚀 Browse top Hacker News stories in your terminal
26-
- ⌨️ Vim-style keyboard navigation
27-
- 🤖 Claude AI integration for story summarization
28-
- 🌐 Open stories directly in your default browser
29-
- 💚 Classic green-on-black terminal aesthetic
30-
- 🎯 Minimalist, distraction-free interface
25+
- 🚀 **Browse** top Hacker News stories in your terminal
26+
- ⌨️ **Vim-style navigation** (j/k, arrows, etc.)
27+
- 🤖 **Claude AI integration** for story summarization
28+
- 🌐 **Open stories** directly in your default browser
29+
- 💚 **Classic green-on-black** terminal aesthetic
30+
- 🎯 **Minimalist, distraction-free interface**
31+
- 🔍 **Instant search/filter**: Press `/` or use the command palette to filter stories as you type
32+
- 🧑‍💻 **Command Palette**: Press `Ctrl+K` to access all commands, including search, section switching, and more
33+
- 📝 **Options menu** for each story (summarize, open, close)
34+
- 🏷️ **Section switching**: Top, Ask, Show, Jobs
35+
- 🛠️ **Easy install & run** with Cargo
36+
37+
## Command Palette 🧑‍💻
38+
39+
Press `Ctrl+K` to open the command palette:
40+
41+
- 🔎 **Search for commands** as you type
42+
-**Quickly switch sections** (Top, Ask, Show, Jobs)
43+
- 🔄 **Refresh** current or all sections
44+
- 🔍 **Activate search mode** (type 'search' and press Enter)
45+
- 🌐 **Open in browser**, 💬 **Open comments**, 🤖 **Summarize**
46+
-**Quit** the app
47+
- ⬆️⬇️ Navigate with Up/Down arrows, `Esc` to close
48+
49+
## Search 🔍
50+
51+
- Press `/` to start searching, or open the command palette and type 'search'
52+
- Type to filter stories by title in real-time
53+
- Use Up/Down arrows to navigate filtered results
54+
- Press Enter to open the selected story, or Esc to cancel
55+
- Works across all sections (Top, Ask, Show, Jobs)
56+
57+
## Keyboard Controls
58+
59+
- `j` or ``: Move down
60+
- `k` or ``: Move up
61+
- `Enter`: Open selected story in default browser
62+
- `C`: Open comments for selected story
63+
- `o`: Open options menu
64+
- `q`: Quit application
65+
- `Esc`: Close menus/summaries
66+
- `T`: Switch to Top stories
67+
- `A`: Switch to Ask HN
68+
- `S`: Switch to Show HN
69+
- `J`: Switch to Jobs
70+
- `h`/`l`: Navigate between sections
71+
- `r`: Refresh current section
72+
- `R`: Refresh all sections
73+
- `Ctrl+K`: Open command palette (search and execute commands)
74+
- `/`: Start search (type to filter stories)
3175

3276
## Installation
3377

@@ -168,14 +212,3 @@ src/
168212
## License
169213

170214
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
171-
172-
### Search
173-
174-
Press `/` to start searching:
175-
- Type to filter stories by title
176-
- Results update in real-time
177-
- Use Up/Down arrows to navigate filtered results
178-
- Press Enter to select or Esc to cancel
179-
- Search works across all sections (Top, Ask, Show, Jobs)
180-
181-
You can also activate search from the command palette (Ctrl+K → type 'search').

0 commit comments

Comments
 (0)