Skip to content

Commit 06132b6

Browse files
committed
Prepare README for public release
1 parent 7734d88 commit 06132b6

3 files changed

Lines changed: 369 additions & 206 deletions

File tree

PUBLISHING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## 1. Prepare the GitHub repository
44

55
- Create or use a public GitHub repository named `homeii-music-flow`.
6+
- Confirm the GitHub repository has a short description and relevant topics such as `home-assistant`, `hacs`, `lovelace`, `music-assistant`, `sendspin`, and `dashboard-card`.
67
- Push the full repository contents, including:
78
- `README.md`
89
- `LICENSE`
@@ -15,6 +16,12 @@
1516
- `src/sendspin-js/`
1617
- `vendor/embla-carousel.umd.js`
1718
- `.github/workflows/validate.yml`
19+
- Confirm the README renders:
20+
- the HOMEii Flow logo
21+
- the preview GIF
22+
- the screenshot tables
23+
- the HACS My Home Assistant button
24+
- the HACS download/install button
1825

1926
## 2. Create the 5.0.0 release
2027

@@ -32,9 +39,15 @@
3239
- Confirm `dist/vendor/embla-carousel.umd.js` exists for mobile swipe support.
3340
- Confirm `dist/homeii-flow-logo.svg` and `docs/brand/homeii-flow-logo.svg` exist.
3441
- Confirm the HACS validation workflow is enabled on GitHub.
42+
- Confirm the README requirements section still matches the current release.
43+
- Confirm the README Sendspin section explains `ma_url`, `ma_token`, local network preference, and the `This device` flow.
3544

3645
## 4. Add the repository to HACS as a custom repository
3746

47+
- Quick link:
48+
49+
`https://my.home-assistant.io/redirect/hacs_repository/?owner=r11a&repository=homeii-music-flow&category=plugin`
50+
3851
- Open Home Assistant.
3952
- Open HACS.
4053
- Open the menu and choose `Custom repositories`.
@@ -67,3 +80,12 @@ to:
6780
Then load:
6881

6982
`/local/community/homeii-music-flow/homeii-music-flow.js?v=5.0.0`
83+
84+
## 7. Final pre-release smoke test
85+
86+
- Load the card after a hard browser refresh.
87+
- Verify main player, compact player, Studio, queue, library, actions, settings, lyrics, announcements, history, recommendations, and night mode screens.
88+
- Verify `This device` creates a HOMEii Sendspin browser player and does not select an unrelated browser player.
89+
- Verify phone, tablet, and desktop layouts.
90+
- Verify light and dark themes.
91+
- Verify HACS install path and manual install path.

0 commit comments

Comments
 (0)