Skip to content

Update README file #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Update README file #117

wants to merge 8 commits into from

Conversation

BDVGitHub
Copy link

@BDVGitHub BDVGitHub commented May 31, 2025

Update readme file to make it easier to install the addon in Home Assistant.
This by using links created with https://my.home-assistant.io/create-link/

Summary by Sourcery

Revamp README to streamline EMHASS add-on installation and improve onboarding in Home Assistant.

Documentation:

  • Add project logo and GitHub release/license badges
  • Embed one-click Home Assistant install and repository links with badges
  • Refine and expand installation steps, including collapsible manual install section

Copy link

sourcery-ai bot commented May 31, 2025

Reviewer's Guide

The PR enriches the README by adding visual badges and images, converting static installation instructions into clickable Home Assistant pre-filled link badges for streamlined setup, and reorganizing legacy manual steps into a collapsible section to improve readability.

File-Level Changes

Change Details Files
Added project logo and status badges to enhance documentation header
  • Inserted EMHASS logo image at top
  • Added GitHub release version badge
  • Added license badge
README.md
Integrated Home Assistant one-click install badges and updated installation steps
  • Replaced plain text install instructions with redirect links and badges
  • Numbered steps for add-on repository, installation, start and configuration
  • Updated step descriptions to include UI actions and recommendations
README.md
Introduced collapsible manual installation guide section
  • Wrapped legacy manual steps inside a
    block
  • Added link badge for opening add-on store
  • Reformatted manual instructions for clarity
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @BDVGitHub - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 4 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@@ -48,11 +56,37 @@ For any Issues/Feature Requests for the EMHASS core module, create a new issue h

The steps to install EMHASS as an Home Assistant addon:

1) Add the EMHASS-Add-on repository to the HAOS add-on store
<a href="https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.51.al%2Fdavidusb-geek%2Femhass-add-on" target="_blank" rel="noreferrer noopener"><img src="https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg" alt="Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled." /></a>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (typo): Typo in alt text: 'add add-on repository' seems like a duplication.

Consider revising the alt text to "Open your Home Assistant instance and show the add-on repository dialog with a specific repository URL pre-filled" for clarity.

Suggested change
<a href="https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.51.al%2Fdavidusb-geek%2Femhass-add-on" target="_blank" rel="noreferrer noopener"><img src="https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg" alt="Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled." /></a>
<a href="https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.51.al%2Fdavidusb-geek%2Femhass-add-on" target="_blank" rel="noreferrer noopener"><img src="https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg" alt="Open your Home Assistant instance and show the add-on repository dialog with a specific repository URL pre-filled." /></a>

README.md Outdated
Comment on lines 88 to 89
- Press the 3 dods and choos repository.
- Add the URL of the repository (e.g https://github.com/davidusb-geek/emhass-add-on) and then press "Add".
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (typo): Typo: 'dods' should be 'dots', 'choos' should be 'choose'.

Suggested change
- Press the 3 dods and choos repository.
- Add the URL of the repository (e.g https://github.com/davidusb-geek/emhass-add-on) and then press "Add".
- Press the 3 dots and choose repository.
- Add the URL of the repository (e.g https://github.com/davidusb-geek/emhass-add-on) and then press "Add".

BDVGitHub and others added 2 commits July 9, 2025 08:45
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
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.

1 participant