From e1bfbaa3ea856e32b27cd3dd01f6a59a5ac55119 Mon Sep 17 00:00:00 2001 From: bvandeusen Date: Sat, 18 Apr 2026 18:05:38 +0000 Subject: [PATCH] docs: expand README with spec links and dev workflow --- README.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 983032a7..0fec0d42 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,27 @@ -# minstrel +# Minstrel -Self-hosted music server with OpenSubsonic compatibility, server-side smart shuffle, dual-like model, session-aware radio, and Lidarr integration. Go + Postgres. \ No newline at end of file +Self-hosted music server with OpenSubsonic compatibility plus an extended API for server-side smart shuffle, a dual-like model (general + contextual), session-aware radio, ListenBrainz scrobble/similarity, and Lidarr integration. Go + Postgres, packaged as a Docker container. + +> State and intelligence belong on the server, not the client. + +## Specs + +Authoritative v1 scope lives under [`docs/`](./docs): + +- [Server spec](./docs/smart-music-server-spec.md) — current implementation focus. +- [Client spec](./docs/smart-music-client-spec.md) — Flutter companion app; work starts once the server reaches its Subsonic-compatible baseline. + +## Development workflow + +- Day-to-day work happens on the `dev` branch (or feature branches merged into `dev`). +- `main` is **protected** — changes land only via pull request from `dev`. +- Production builds are cut by tagging a release (`v*`) off `main`. + +## CI / container image + +Forgejo Actions handles: + +- Tests on push to `dev` and on PRs into `main`. +- Container image build + push to the Forgejo registry on merge to `main` (`:main`) and on `v*` tags (`:`). + +Task and milestone tracking: Fable (`Minstrel` project, id 12).