Skip to content

Commit 4be9728

Browse files
committed
doc: update badges, odio, apt installation with quickstart
1 parent 540e251 commit 4be9728

1 file changed

Lines changed: 19 additions & 7 deletions

File tree

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
[![CI](https://github.com/b0bbywan/go-odio-api/actions/workflows/ci.yml/badge.svg)](https://github.com/b0bbywan/go-odio-api/actions/workflows/ci.yml)
66
[![Build](https://github.com/b0bbywan/go-odio-api/actions/workflows/build.yml/badge.svg)](https://github.com/b0bbywan/go-odio-api/actions/workflows/build.yml)
77
[![Go Report Card](https://goreportcard.com/badge/github.com/b0bbywan/go-odio-api)](https://goreportcard.com/report/github.com/b0bbywan/go-odio-api)
8+
[![GitHub Sponsors](https://img.shields.io/github/sponsors/b0bbywan?label=Sponsor&logo=GitHub)](https://github.com/sponsors/b0bbywan)
9+
10+
> Part of the [odio](https://odio.love/) project.
811
912
Odio is an ultra-lightweight Go daemon that exposes a single clean REST API over your Linux user session's D-Bus: MPRIS players (Spotify, VLC, Firefox, MPD, Kodi), PulseAudio/PipeWire, systemd user services, and power management. No root. No hacks. Just Linux primitives.
1013

@@ -17,21 +20,21 @@ Works without any system tweak.
1720

1821
## Quick Start
1922

20-
Start Spotify, VLC, or any MPRIS player first, then:
21-
2223
```bash
23-
# 1. Config (bind: all required for Docker)
24-
cp share/config.yaml config.yaml
24+
# 1. Install
25+
curl -fsSL https://apt.odio.love/key.gpg | sudo gpg --dearmor -o /usr/share/keyrings/odio.gpg
26+
echo "deb [signed-by=/usr/share/keyrings/odio.gpg] https://apt.odio.love stable main" | sudo tee /etc/apt/sources.list.d/odio.list
27+
sudo apt update && sudo apt install odio-api
2528

2629
# 2. Start
27-
docker compose up -d
30+
systemctl --user enable --now odio-api.service
2831

29-
# 3. Test
32+
# 3. Test (start any MPRIS player first — Spotify, VLC, MPD…)
3033
curl http://localhost:8018/players
3134
curl http://localhost:8018/audio/server
3235
```
3336

34-
→ See [Installation](#installation) for systemd service, packages, or running from source.
37+
→ See [Installation](#installation) for RPM, Docker, or building from source.
3538

3639
## User Interface
3740

@@ -253,6 +256,15 @@ Pre-built packages (amd64, arm64, armv7hf, armhf/ARMv6) and a multi-arch Docker
253256

254257
## Installation
255258

259+
### APT Repository (Debian / Raspberry Pi OS)
260+
261+
```bash
262+
curl -fsSL https://apt.odio.love/key.gpg | sudo gpg --dearmor -o /usr/share/keyrings/odio.gpg
263+
echo "deb [signed-by=/usr/share/keyrings/odio.gpg] https://apt.odio.love stable main" | sudo tee /etc/apt/sources.list.d/odio.list
264+
sudo apt update
265+
sudo apt install odio-api
266+
```
267+
256268
### Packages (deb / rpm)
257269

258270
Pre-built packages for amd64, arm64, armv7hf, and armhf (ARMv6) are available as artifacts on each [build workflow run](https://github.com/b0bbywan/go-odio-api/actions/workflows/build.yml).

0 commit comments

Comments
 (0)