Skip to content

docs: explain how this integration differs from the core one - #160

Open
kbaker827 wants to merge 2 commits into
OpenDisplay:mainfrom
kbaker827:docs/138-core-vs-hacs
Open

kbaker827 wants to merge 2 commits into
OpenDisplay:mainfrom
kbaker827:docs/138-core-vs-hacs

Conversation

@kbaker827

Copy link
Copy Markdown

Fixes #138

Summary

Adds a README section acknowledging the built-in integration, a feature comparison, and when to choose each. The table comes from reading both codebases (Home Assistant dev, November 2026).

For maintainers to check

#138 also asks how the two relate and whether they will converge. I left that out because it is a project decision I can't answer from the code. Please add it, and correct the recommendation wording if it doesn't match your intent.

🤖 Generated with Claude Code

Fixes OpenDisplay#138

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kbaker827
kbaker827 requested a review from g4bri3lDev as a code owner November 6, 2026 16:13
@kbaker827

Copy link
Copy Markdown
Author

CI is waiting on maintainer approval here, so I ran the workflows on my fork at d83c9cc:

  • Tests: passed, on both the latest and min-ha Home Assistant, plus ruff
  • hassfest: passed
  • HACS: 8 of 10 checks passed. The two failures are fork settings (issues disabled, no topics), and the fork's unmodified main fails the same two.

This covers this branch on its own, not merged with the other open PRs, and nothing has been run on real hardware.

@Misiu

Misiu commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

In 2026.11 HACS is replaced by Marketplace. I think this should be mentioned.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kbaker827

Copy link
Copy Markdown
Author

Thanks, good catch. Updated in 9357fb1: the comparison section and the install instructions now point to the Marketplace, with HACS mentioned for Home Assistant versions before 2026.11. I kept the My Home Assistant button, since that link opens the Marketplace on 2026.11.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update README.md to reflect differences with Core module

2 participants