Add documentation for using the next version

[tomquist]

Added a new section "Using the Next Version" to the README that explains how to use the development version tagged as "next" for both Docker and Home Assistant deployments.

Summary by CodeRabbit

• Documentation
  • Added a "Using the Development Version" section with guidance for using the development image/tag, Docker run and Docker Compose examples, Home Assistant integration notes (referencing the develop branch), and a stability warning.
  • Note: the new section was accidentally duplicated in the README.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

A new "Using the Development Version" section is added to the README, providing setup instructions for the development Docker image tag (next), including docker-compose examples and Home Assistant integration guidance. This section appears twice in the file.

Changes

Cohort / File(s)	Summary
Documentation README.md	Added "Using the Development Version" section twice documenting the next Docker image tag, docker run and docker-compose usage, Home Assistant repository/add-on guidance, and stability warnings. Potential duplication across two locations in the file requires review.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title 'Add documentation for using the next version' directly aligns with the main objective of adding a README section explaining how to use the development 'next' tagged version for Docker and Home Assistant deployments.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9f0bf8c and a90d63c.

📒 Files selected for processing (1)

• README.md

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

225-227: Add language specifier to fenced code block.

The code block at line 225 is missing a language identifier after the opening fence. While this is valid Markdown, it's better practice to specify the format for syntax highlighting.

🔎 Proposed fix

- ```
+ ```url
  https://github.com/tomquist/hame-relay#develop
- ```
+ ```

Alternatively, if no syntax highlighting is desired, you may leave it blank (```) or use text.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e3f2d41 and 9f0bf8c.

📒 Files selected for processing (1)

• README.md

🧰 Additional context used

🪛 LanguageTool

README.md

[grammar] ~229-~229: Ensure spelling is correct
Context: ...ame-relay#develop ``` Then install the "Hame Relay" add-on from this repository to g...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🪛 markdownlint-cli2 (0.18.1)

README.md

225-225: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: build (linux/arm/v7)
• GitHub Check: build-addon (linux/arm/v7)

🔇 Additional comments (1)

README.md (1)

196-229: Clear, well-structured documentation with appropriate warnings.

The new "Using the Development Version" section is well-organized and provides clear instructions for both Docker and Home Assistant environments. The warning at line 200 appropriately communicates the risks of using the development build. The Home Assistant repository URL format with the #develop fragment is correctly specified per the PR objectives.