Table of Contents
-
About The Project
-
Getting Started
- Usage
- Roadmap
- Contributing
- License
- Contact
- 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 tap iamlucasvieira/hnews
brew install 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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
)
- Commit your Changes (
git commit -m 'Add some AmazingFeature'
)
- Push to the Branch (
git push origin feature/AmazingFeature
)
- Open a Pull Request
(back to top)
License
Distributed under the MIT License. See LICENSE.txt
for more information.
(back to top)
Lucas Vieira dos Santos - Email
Project Link: https://github.com/iamlucasvieira/hnews
(back to top)
Acknowledgments
(back to top)