Rename project and add proper README

.goreleaser.yml

@@ -6,7 +6,7 @@ before:
     - go mod tidy
 
 builds:
-  - binary: Nachrichten
+  - binary: nachrichten
     flags:
       - -trimpath
     ldflags: -s -w -X main.Version={{ .Version }} -X main.CommitSHA={{ .Commit }}
@@ -22,11 +22,11 @@ builds:
 
 nfpms:
   - builds:
-      - Nachrichten
+      - nachrichten
     vendor: Moooooritz
     homepage: "https://github.com/zMoooooritz"
     maintainer: "Moritz Biering <[email protected]>"
-    description: "A TUI application to read German news"
+    description: "A TUI application for reading German news"
     license: MIT
     formats:
       - apk

README.md

@@ -1,5 +1,28 @@
 
-# Nachrichten
+nachrichten
+======
 
-A small TUI application that allows reading the current (German) news in the console.
+<p align="center">
+    <a href="https://github.com/zMoooooritz/nachrichten/actions"><img src="https://github.com/zMoooooritz/nachrichten/workflows/build/badge.svg" alt="Build Status"></a>
+    <a href="https://github.com/zMoooooritz/nachrichten/releases"><img src="https://img.shields.io/github/v/release/zMoooooritz/nachrichten" alt="Latest Release"></a>
+    <a href="https://goreportcard.com/report/github.com/zMoooooritz/nachrichten"><img src="https://goreportcard.com/badge/zMoooooritz/nachrichten" alt="Go ReportCard"></a>
+    <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
+</p>
+
+A small TUI for reading German news
+
+## Installation 
+Install directly using Go
+```
+go install github.com/zMoooooritz/nachrichten@latest
+```
+or download from [releases](https://github.com/zMooooritz/nachrichten/releases)
+
+## Usage
+To launch the tool, run the `nachrichten` command
+
+Press the `?` key to show the available keybinds
+
+## Built with
+- [bubbletea](https://github.com/chrmbracelet/bubbletea) and its ecosystem
 

cmd/main.go

@@ -5,8 +5,8 @@ import (
 	"os"
 
 	tea "github.com/charmbracelet/bubbletea"
-	"github.com/zMoooooritz/Nachrichten/pkg/config"
-	"github.com/zMoooooritz/Nachrichten/pkg/tui"
+	"github.com/zMoooooritz/nachrichten/pkg/config"
+	"github.com/zMoooooritz/nachrichten/pkg/tui"
 )
 
 func Run() {

go.mod

@@ -1,4 +1,4 @@
-module github.com/zMoooooritz/Nachrichten
+module github.com/zMoooooritz/nachrichten
 
 go 1.20
 

main.go

@@ -1,6 +1,6 @@
 package main
 
-import "github.com/zMoooooritz/Nachrichten/cmd"
+import "github.com/zMoooooritz/nachrichten/cmd"
 
 func main() {
 	cmd.Run()

pkg/http/http.go

@@ -8,7 +8,7 @@ import (
 
 const (
 	httpTimeout time.Duration = 2
-	agentName   string        = "Nachrichten-Agent"
+	agentName   string        = "nachrichten-agent"
 )
 
 func FetchURL(url string) ([]byte, error) {

pkg/tagesschau/api.go

@@ -9,7 +9,7 @@ import (
 
 	"github.com/PuerkitoBio/goquery"
 	"github.com/buger/jsonparser"
-	"github.com/zMoooooritz/Nachrichten/pkg/http"
+	"github.com/zMoooooritz/nachrichten/pkg/http"
 )
 
 const (

pkg/tui/helper.go

@@ -4,7 +4,7 @@ import (
 	"github.com/charmbracelet/bubbles/help"
 	"github.com/charmbracelet/bubbles/list"
 	"github.com/charmbracelet/bubbles/spinner"
-	"github.com/zMoooooritz/Nachrichten/pkg/config"
+	"github.com/zMoooooritz/nachrichten/pkg/config"
 )
 
 func EmptyLists(s config.Style, count int) []list.Model {

pkg/tui/newslist.go

@@ -8,8 +8,8 @@ import (
 	"github.com/charmbracelet/bubbles/list"
 	tea "github.com/charmbracelet/bubbletea"
 	"github.com/muesli/reflow/truncate"
-	"github.com/zMoooooritz/Nachrichten/pkg/config"
-	"github.com/zMoooooritz/Nachrichten/pkg/tagesschau"
+	"github.com/zMoooooritz/nachrichten/pkg/config"
+	"github.com/zMoooooritz/nachrichten/pkg/tagesschau"
 )
 
 type NewsDelegate struct {

pkg/tui/tui.go

@@ -11,9 +11,9 @@ import (
 	"github.com/charmbracelet/bubbles/viewport"
 	tea "github.com/charmbracelet/bubbletea"
 	"github.com/charmbracelet/lipgloss"
-	"github.com/zMoooooritz/Nachrichten/pkg/config"
-	"github.com/zMoooooritz/Nachrichten/pkg/tagesschau"
-	"github.com/zMoooooritz/Nachrichten/pkg/util"
+	"github.com/zMoooooritz/nachrichten/pkg/config"
+	"github.com/zMoooooritz/nachrichten/pkg/tagesschau"
+	"github.com/zMoooooritz/nachrichten/pkg/util"
 )
 
 const (

pkg/util/opener.go

@@ -4,7 +4,7 @@ import (
 	"os/exec"
 	"runtime"
 
-	"github.com/zMoooooritz/Nachrichten/pkg/config"
+	"github.com/zMoooooritz/nachrichten/pkg/config"
 )
 
 func OpenUrl(t config.ResourceType, c config.Configuration, url string) error {

pkg/util/util.go

@@ -6,8 +6,8 @@ import (
 	md "github.com/JohannesKaufmann/html-to-markdown"
 	"github.com/charmbracelet/glamour"
 	"github.com/charmbracelet/lipgloss"
-	"github.com/zMoooooritz/Nachrichten/pkg/config"
-	"github.com/zMoooooritz/Nachrichten/pkg/tagesschau"
+	"github.com/zMoooooritz/nachrichten/pkg/config"
+	"github.com/zMoooooritz/nachrichten/pkg/tagesschau"
 )
 
 func ContentToText(content []tagesschau.Content, width int, s config.Style) string {