Skip to content

Commit

Permalink
docs: minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
TypicalAM committed Aug 26, 2023
1 parent 1c8f42b commit 43e27ba
Showing 1 changed file with 9 additions and 18 deletions.
27 changes: 9 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@

### Installing with `go install`

Install with
You can install goread using the `go` internal package manager

```
go install github.com/TypicalAM/goread@latest
$ go install github.com/TypicalAM/goread@latest
```

### Installing with `homebrew`
Expand All @@ -29,14 +29,16 @@ If you use [Homebrew](https://brew.sh/), you can install [goread](https://formul
$ brew install goread
```

### Installing from AUR (yay)
### Installing from AUR

If you use the [AUR](https://aur.archlinux.org/), you can install [goread](https://aur.archlinux.org/packages/goread) via:

```
yay -S goread
$ yay -S goread
```

```
yay -S goread-bin # Release binary
$ yay -S goread-bin # Release binary
```

## 📸 What does it look like?
Expand Down Expand Up @@ -106,22 +108,11 @@ pywal `colors.json` file which is usually located at `~/.cache/wal/colors.json`.

## ✨ Contributing

### TODOs

Here are the things that I've not yet implemented, contributions and suggestions are very welcome!

- [x] URL highlighting and opening
- [x] Automatically theming the glamour viewer
- [ ] AI-Generated feed suggestions
- [ ] Adding customizable keybinds

### Issues

If something doesn't work feel free to create an issue:
If you have an idea or something doesn't work feel free to create an issue. If it is a bug remember to:

- Update using `go install github.com/TypicalAM/goread@latest` or `homebrew upgrade`
- Include output of `goread --version`
- Include logs are usually located at `/tmp/goread.log` on linux and `%TMP%\goread.log` on Windows
- Include logs which are usually located at `/tmp/goread.log` on linux and `%TMP%\goread.log` on Windows

## 💁 Credit where credit is due

Expand Down

0 comments on commit 43e27ba

Please sign in to comment.