Skip to content

Commit

Permalink
Improve README (#61)
Browse files Browse the repository at this point in the history
  • Loading branch information
zMoooooritz committed Jan 13, 2024
1 parent 7c1f867 commit 73fde9e
Showing 1 changed file with 44 additions and 8 deletions.
52 changes: 44 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,58 @@ nachrichten
[![Build Status](https://img.shields.io/github/actions/workflow/status/zMoooooritz/nachrichten/build.yml?branch=master&style=for-the-badge)](https://github.com/zMoooooritz/nachrichten/actions)
[![Go ReportCard](https://goreportcard.com/badge/github.com/zMoooooritz/nachrichten?style=for-the-badge)](https://goreportcard.com/report/zMoooooritz/nachrichten)

A small TUI for reading German news
Stay informed without leaving your command line

Access up-to-date news in German provided by the [tagesschau](https://www.tagesschau.de/)

<img alt="Welcome to nachrichten" src="https://github.com/zMoooooritz/nachrichten/blob/media/media/demo.gif" width="800" />

## Installation
## Installation
Install directly using Go
```go
```bash
go install github.com/zMoooooritz/nachrichten@latest
```
or download from [releases](https://github.com/zMoooooritz/nachrichten/releases)

## Usage
To launch the tool, run the `nachrichten` command
## ⇁ Usage
Run the `nachrichten` command to launch the minimalistic terminal interface

```bash
Usage of nachrichten:
-config string
Path to configuration file
-debug string
Path to log file
-shortnews
Only open the current short news
-version
Display version
```

## ⇁ Configuration
The tool does allow for user constomization
1. **Theme** - Adapt the used colors in order to change the look and feel of the application
2. **Keybinds** - Customize all keys used within the application
3. **Applications** - Some news related resources can't be shown in a TUI, configure the apps used to open those resources
4. **Settings** - General settings that alter the behaviour of the application

An example configuration can be found [here](https://github.com/zMoooooritz/nachrichten/blob/master/configs/config.yaml)

The default keybinds are as follows:

Press the `?` key to show the available keybinds
| Key | Action |
| ---------------- | ---------------------- |
| arrows / hjkl | navigation |
| g / G | goto start / end |
| tab / shift+tab | change tabs |
| f | maximize reader/viewer |
| i | toggle thumbnail |
| o | open article url |
| v | open article vod |
| s | open current news vod |
| ? | toggle help |
| q / esc / ctrl+c | quit |

## Built with
- [bubbletea](https://github.com/charmbracelet/bubbletea) and its ecosystem
## Built with
- [bubbletea](https://github.com/charmbracelet/bubbletea) and its awesome ecosystem

0 comments on commit 73fde9e

Please sign in to comment.