Skip to content
This repository has been archived by the owner on Jan 6, 2024. It is now read-only.

📚 Add My buttons to documentation #171

Merged
merged 1 commit into from
Mar 22, 2022
Merged

📚 Add My buttons to documentation #171

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion home-panel/DOCS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,12 @@ customisable and themeable card based UI which can be used on a touch screen.
The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Home Assistant add-on.

1. Search for the "Home Panel" add-on in the add-on store and install it.
1. Click the Home Assistant My button below to open the add-on on your Home
Assistant instance.

[![Open this add-on in your Home Assistant instance.][addon-badge]][addon]

1. Click the "Install" button to install the add-on.
1. Configure the "Home Panel" add-on. (See below)
1. Start the "Home Panel" add-on.
1. Check the logs of the "Home Panel" add-on to see it in action.
Expand All @@ -18,6 +23,12 @@ comparison to installing any other Home Assistant add-on.
1. Once logged in, log into Home Assistant via the sidebar.
1. Please see [here][config] for how to configure Home Panel.

Home Assistant, by default, ships with the Community Add-ons store installed.
However, if it is missing (for any reason), you can add it by clicking the
button My button below.

[![Add repository to your Home Assitant instance.][repository-badge]][repository]

## Configuration

**Note**: _Remember to restart the add-on when the configuration is changed._
Expand Down Expand Up @@ -125,6 +136,8 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

[addon-badge]: https://my.home-assistant.io/badges/supervisor_addon.svg
[addon]: https://my.home-assistant.io/redirect/supervisor_addon/?addon=a0d7b954_home-panel
[config]: https://home-panel-docs.timmo.dev/configui/
[contributors]: https://github.com/hassio-addons/addon-home-panel/graphs/contributors
[discord-ha]: https://discord.gg/c5DvZ4e
Expand All @@ -134,6 +147,8 @@ SOFTWARE.
[issue]: https://github.com/hassio-addons/addon-home-panel/issues
[reddit]: https://reddit.com/r/homeassistant
[releases]: https://github.com/hassio-addons/addon-home-panel/releases
[repository-badge]: https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg
[repository]: https://github.com/hassio-addons/repository
[repository]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fhassio-addons%2Frepository
[semver]: http://semver.org/spec/v2.0.0.htm
[timmo]: https://github.com/timmo001