Hnews

A simple Hacker News front page reader on your terminal.
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Hnews is a simple Hacker News front page reader on your terminal.

(back to top)

Built With

(back to top)

Getting Started

To get hnews up and running follow these simple steps.

Installation

MacOS (Homebrew)

For MacOS users, you can install hnews using Homebrew.

brew install iamlucasvieira/tap/hnews

Windows/Linux/MacOS (Go)

You can also install hnews using Go.

go install github.com/iamlucasvieira/hnews@latest

(back to top)

Usage

With hnews installed, you only need to run the command hnews on your terminal.

(back to top)

Roadmap

• Add searching feature
• Add time machine feature, allowing to see the front page of a specific date
• Add page with comments of a specific post

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Lucas Vieira dos Santos - Email

Project Link: https://github.com/iamlucasvieira/hnews

(back to top)

Acknowledgments

• Charmbracelet: Only with their amazing bubbletea framework I was able to make `hnews look so good.

(back to top)