diff --git a/README.md b/README.md new file mode 100644 index 0000000..7f824f6 --- /dev/null +++ b/README.md @@ -0,0 +1,145 @@ +# Music + +The music library for an Officer server: browse `~/Music`, play it in the browser, and serve a synced +index to phone and tablet apps. + +Music assumes you already have a library on disk — folders of files you organised yourself — and does +not try to become the place you organise it. It indexes what is there, compresses the covers, reads the +tags and lyrics, and serves the result over HTTP. The `/music` screen is one client of that API; the +mobile apps are another. Nothing is imported, moved or renamed, and removing the plugin leaves the +library exactly as it was. + +## What you get + +- **A library screen** at `/music` — a drill-down list on the left, the detail view on the right. An + album shows its tracklist, an artist shows its albums grouped by release type, anything else shows a + folder grid. Every location is a link, so `?path=` is the address of what you are looking at and + cmd-click works. +- **Gapless playback in the browser.** Web Audio rather than an `