Skip to content

Commit e5d7240

Browse files
committed
docs: improve README install and features
1 parent 89a15d0 commit e5d7240

File tree

2 files changed

+26
-8
lines changed

2 files changed

+26
-8
lines changed

.goreleaser.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
version: 2
2+
project_name: blucli
23

34
before:
45
hooks:
@@ -24,6 +25,11 @@ archives:
2425
- id: default
2526
builds:
2627
- blu
28+
name_template: >-
29+
{{ .ProjectName }}-{{- if eq .Os "darwin" -}}macos{{- else if eq .Os "windows" -}}windows{{- else -}}{{ .Os }}{{- end -}}-{{ .Arch }}
30+
files:
31+
- LICENSE
32+
- README.md
2733
format_overrides:
2834
- goos: windows
2935
format: zip

README.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,35 @@
1-
# blucli
1+
# 🫐 blucli — play, group, and automate BluOS.
22

33
BluOS CLI (`blu`) for Bluesound/NAD BluOS players.
44

55
Spec: `docs/spec.md`
66

7-
## Install
7+
## Install / Run
88

9-
```bash
10-
go install github.com/steipete/blucli/cmd/blu@latest
11-
```
9+
- Homebrew (installs `blu`): `brew install steipete/tap/blucli`
10+
- Go install: `go install github.com/steipete/blucli/cmd/blu@latest`
11+
- From source: `go run ./cmd/blu --help`
1212

13-
Or grab a prebuilt binary from GitHub Releases.
13+
## Features
14+
15+
- Discovery: mDNS (`_musc/_musp/_musz/_mush`) + LSDP fallback (`blu devices`)
16+
- Device selection: `--device`, `BLU_DEVICE`, config `default_device`, aliases
17+
- Playback: `play/pause/stop/next/prev` + `play --url/--seek/--id`
18+
- Volume + modes: `volume …`, `mute …`, `shuffle …`, `repeat …`
19+
- Grouping: `group status|add|remove`
20+
- Queue/presets/browse: `queue …`, `presets …`, `browse …`, `playlists …`, `inputs …`
21+
- TuneIn: `tunein search|play` for quick “play X”
22+
- Spotify Connect: `spotify open` (and optional Web API `spotify login/search/play`)
23+
- Watch: long-poll `Status` / `SyncStatus` (`watch status|sync`)
24+
- Scripting/safety: `--json`, `--dry-run`, `--trace-http`
25+
- Diagnostics: `diag`, `doctor`, `raw` endpoint runner
26+
- Shell completions: `completions bash|zsh`
1427

1528
## Quickstart
1629

1730
```bash
1831
blu devices
1932
blu --device 192.168.1.19:11000 status
20-
21-
blu --json status
2233
```
2334

2435
## Device selection
@@ -36,6 +47,7 @@ If multiple devices exist, run `blu devices` and pick one.
3647

3748
Config file:
3849
- macOS: `~/Library/Application Support/blu/config.json`
50+
- Linux: `~/.config/blu/config.json`
3951

4052
Example:
4153

0 commit comments

Comments
 (0)