5 Commits

Author SHA1 Message Date
Edi Piqoni
419623e263 Merge branch 'main' of github.com:piqoni/hn-text 2024-06-02 20:13:03 +02:00
Edi Piqoni
3a16f03370 update module name so it can be installed via GO INSTALL 2024-06-02 20:12:50 +02:00
EP
a181a31d8f Update README.md 2024-06-02 19:39:50 +02:00
EP
b43d8566b9 Create README.md 2024-06-02 19:38:07 +02:00
EP
90572784b8 Merge pull request #1 from piqoni/tests
tests pipeline
2024-06-02 19:25:25 +02:00
2 changed files with 25 additions and 1 deletions

24
README.md Normal file
View File

@@ -0,0 +1,24 @@
<img align="right" src="https://github.com/piqoni/hn-text/actions/workflows/test.yml/badge.svg">
<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">

2
go.mod
View File

@@ -1,4 +1,4 @@
module hn-text
module github.com/piqoni/hn-text
go 1.21.1