Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
piqoni authored Jun 2, 2024
1 parent 9057278 commit b43d856
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<h1 align="center"> HN-text </h1>
<p align="center"> HN-text: a fast, easy-to-use and distraction-free Hacker News terminal client.</p>

<div align="center"> <img width="500" src="https://github.com/piqoni/hn-text/assets/3144671/339fe90f-29e8-4e58-b185-dfa9ce86464d"/> </div>

# Motivations:
- Easy to use (arrow keys or hjkl navigation should be enough for the client to be fully usable)
- Distraction Free: articles, and comments are converted to simple readble text.
- Fast Navigation and Responsivity

# Current Features / Screenshots
- Navigation and opening pages (text-version): ←↓↑→ arrow keys (or hjkl) will navigate from the HN Frontpage → Comments Page → Article's Text and back.
- Open article in default's browser (**SPACE** key), Comment page ('**c**' key).
- Append "best" as argument if you want to see Hacker News Best page, instead of the default frontpage.

## Frontpage
<img width="641" alt="image" src="https://github.com/piqoni/hn-text/assets/3144671/92beba8d-1a44-400a-8f0c-a3372a221d58">

## Comments
<img width="787" alt="image" src="https://github.com/piqoni/hn-text/assets/3144671/fca7672a-d7a5-4e70-a636-95595b58d5ba">

## Article
<img width="940" alt="image" src="https://github.com/piqoni/hn-text/assets/3144671/c4a6d098-7f79-4c81-8cd7-0506fe6aab23">

0 comments on commit b43d856

Please sign in to comment.