-
Notifications
You must be signed in to change notification settings - Fork 36
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
base: main
Are you sure you want to change the base?
Update README file #117
Conversation
Add badges
Make it easier to install the add on
Reviewer's GuideThe 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this 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
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> |
There was a problem hiding this comment.
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.
<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
- 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". |
There was a problem hiding this comment.
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'.
- 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". |
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>
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: