diff --git a/README.md b/README.md index 392b7c3..734f91d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,17 @@ -# hmhm - TUI news reading client 🦞 +# hmhm 🦞 + +List latest news items from Hacker News and Lobste.rs in the terminal. hmhm is a tool I developed to get a feeling how one could develop a TUI (Terminal User Interface) based app in Go. -I tried a few TUI high level libraries but settled on [tview](https://github.com/rivo/tview). +I tried a few TUI high level libraries but settled on [termui](https://github.com/gizak/termui). + +## Simple usage +* Up, down, k or j keys - to change focus up or down. +* Left, Right, h or l - to switch tab. +* Enter - open up web browser with the URL for the focused news item. +* Escape or q - to quit + ### Loading news items. ![Loading news items.](assets/img/hmhm-loading.png)