@brianlovin/hn-cli 0.3.0 → 0.4.0

package/README.md

@@ -40,6 +40,7 @@ bun run start
 | `⌘j` / `⌘k` | Navigate between root-level comments |
 | `o`         | Open story URL in browser            |
 | `c`         | Chat with AI about the story         |
+| `s`         | Open settings                        |
 | `r`         | Refresh stories                      |
 | `q`         | Quit                                 |
 
@@ -70,15 +71,6 @@ export OPENAI_API_KEY=sk-...
 
 Press `c` to start a chat, and you'll be guided through the setup. Your key is stored locally at `~/.config/hn-cli/config.json`.
 
-**Settings**
-
-While in chat mode, press `,` to access settings where you can:
-
-- Switch between Anthropic and OpenAI
-- Change the model
-- Add additional API keys
-- Clear stored keys
-
 ---
 
 ## Development
@@ -89,6 +81,21 @@ While in chat mode, press `,` to access settings where you can:
 bun install          # Install dependencies
 bun run start        # Run the app
 bun run dev          # Run with hot reload
+bun run dev:update   # Run with simulated update notification
+```
+
+### Testing the update notification
+
+To test the update notification UI without publishing a new version:
+
+```bash
+bun run dev:update
+```
+
+You can also customize the simulated versions:
+
+```bash
+HN_SIMULATE_VERSION=0.2.0 HN_SIMULATE_LATEST=0.5.0 bun run start
 ```
 
 ### Testing
@@ -112,23 +119,78 @@ bun run debug highlighted-comment  # Test comment highlighting
 - `src/app.ts` - Main app class with UI and keyboard handling
 - `src/api.ts` - API client for fetching from HNPWA API
 - `src/config.ts` - Configuration and API key management
+- `src/settings.ts` - Configurable filter settings with validation
 - `src/types.ts` - TypeScript types for HN data structures
 - `src/test/` - Test suite
 
+## Settings
+
+Press `s` at any time to open the settings panel. Use `j`/`k` to navigate, `←`/`→` or `Enter` to adjust values, and `r` to reset all settings to defaults.
+
+### AI Provider
+
+- Switch between Anthropic and OpenAI
+- Change the model (Claude Sonnet/Haiku, GPT-4o/4o-mini)
+- Add or clear API keys
+
+### Story Filtering
+
+These settings control which stories appear in your feed:
+
+| Setting          | Default | Description                                       |
+| ---------------- | ------- | ------------------------------------------------- |
+| Max Stories      | 24      | Maximum number of stories to display              |
+| Time Window      | 24h     | Only show stories from the last N hours           |
+| Min Points       | 50      | Minimum upvotes required (OR min comments)        |
+| Min Comments     | 20      | Minimum comments required (OR min points)         |
+
+### Comment Display
+
+| Setting          | Default | Description                                       |
+| ---------------- | ------- | ------------------------------------------------- |
+| Root Comments    | 12      | Maximum root-level comments shown per story       |
+| Child Comments   | 8       | Maximum replies shown per comment                 |
+| Nesting Depth    | 3       | Maximum levels of nested replies                  |
+
+Settings are stored locally at `~/.config/hn-cli/config.json`.
+
 ## Design decisions
 
-This CLI matches the implementation of my HN reader on my [personal website](https://brianlovin.com/hn):
+The default settings match my HN reader on my [personal website](https://brianlovin.com/hn). I made these choices so that it's easier for me to keep up with the most interesting stories throughout the day without getting sucked too deep into long comment threads or the flood of new submissions.
+
+All defaults are now customizable via the settings panel (`s`).
+
+## Telemetry
+
+This CLI collects anonymous usage data to help understand how people use it and what features to improve. No personal information or content is ever collected.
 
-- Only shows posts from the last 24 hours
-- Only shows "link" type posts (excludes jobs, polls)
-- Requires minimum story engagement: 50+ points OR 20+ comments
-- Ranked by: points + (comments × 0.75) + recency bonus
-- Maximum 24 posts displayed
-- Comments: max 12 root comments, max 8 children per parent, max 3 levels deep
+### What's collected
 
-I made these choices so that it's easier for me to keep up with the most interesting stories throughout the day without getting sucked too deep into long comment threads or the flood of new submissions.
+- App launches (with version number)
+- Feature usage counts (TLDR, chat, refresh)
+- Navigation patterns (stories selected, comments viewed)
+- Keyboard shortcut usage
+
+### What's NOT collected
+
+- Story content, titles, or URLs
+- Chat messages or AI responses
+- API keys or credentials
+- IP addresses or location data
+
+### Disabling telemetry
+
+**Option 1: Settings menu**
+
+Press `s` to open settings, then toggle "Telemetry" off.
+
+**Option 2: Launch flag**
+
+```bash
+hn --disable-telemetry
+```
 
-If you want your version of this tool to work differently, feel free to clone or consider opening a PR with more advanced settings to let people customize the default experience.
+This permanently disables telemetry. Your preference is stored locally at `~/.config/hn-cli/config.json`.
 
 ## Credits