Skip to content

Commit

Permalink
Remove custom repo step from README setup instructions (#85)
Browse files Browse the repository at this point in the history
* Remove custom repo step from setup instructions

* Update README.md

* Replace badge from "custom" to "default"

* Update README.md

* Update README.md

---------

Co-authored-by: Edward Firmo <[email protected]>
  • Loading branch information
ThomDietrich and edwardtfn authored Sep 26, 2023
1 parent 1c7e4ee commit 761d182
Showing 1 changed file with 12 additions and 16 deletions.
28 changes: 12 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg)](https://github.com/hacs/integration)
[![hacs_badge](https://img.shields.io/badge/HACS-Default-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration)

# Lovelace Horizon Card

Expand All @@ -14,11 +14,11 @@ The Horizon Card tracks the position of the Sun and the Moon over the horizon an

Light theme default look | Dark theme default look
:-----------------------------:|:-----------------------------:
![](images/default-light.png) | ![](images/default-dark.png)
![](https://github.com/rejuvenate/lovelace-horizon-card/blob/main/images/default-light.png) | ![](https://github.com/rejuvenate/lovelace-horizon-card/blob/main/images/default-dark.png)

Light theme full look | Dark theme full look
:-----------------------------:|:-----------------------------:
![](images/full-light.png) | ![](images/full-dark.png)
![](https://github.com/rejuvenate/lovelace-horizon-card/blob/main/images/full-light.png) | ![](https://github.com/rejuvenate/lovelace-horizon-card/blob/main/images/full-dark.png)

### How it works

Expand All @@ -37,28 +37,24 @@ If showing the moon phase is enabled, the icon will be rotated to match the appr

## Installation

Please ensure you have the [Sun integration](https://www.home-assistant.io/integrations/sun/) enabled in your Home Assistant setup.
Please ensure you have [HACS](https://hacs.xyz/) and the [Sun integration](https://www.home-assistant.io/integrations/sun/) enabled in your Home Assistant setup.

### HACS
If you have My Home Assistant configured, simply click here:

1. Make sure the [HACS](https://github.com/custom-components/hacs) component is installed and working.
1. Add the project repository `https://github.com/rejuvenate/lovelace-horizon-card` as a custom repository to HACS, see: https://hacs.xyz/docs/faq/custom_repositories
[![Open your Home Assistant instance and open the lovelace-horizon-card project inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=rejuvenate&repository=lovelace-horizon-card)

Otherwise follow these steps:

<picture>
<source media="(prefers-color-scheme: light)" srcset="https://github.com/Mqxx/GitHub-Markdown/blob/main/blockquotes/badge/light-theme/info.svg">
<img alt="Info" src="https://github.com/Mqxx/GitHub-Markdown/blob/main/blockquotes/badge/dark-theme/info.svg">
</picture><br>
Addition to the HACS default repository is pending (see: https://github.com/hacs/default/pull/1958).
This step won't be necessary afterwards.
1. Search for `lovelace-horizon-card` in HACS and install it under the "Lovelace" category.
1. Make sure the [HACS](https://github.com/custom-components/hacs) component is installed and working.
1. Search for "Horizon Card" or `lovelace-horizon-card` in HACS and install the latest version.

### Manual Installation

Installation via HACS is recommended, but a manual setup is supported.

<details>
<summary>Show detailed instructions</summary>

Installation via HACS is recommended, but a manual setup is supported.

1. Download the latest [lovelace-horizon-card.js](https://github.com/rejuvenate/lovelace-horizon-card/releases/latest/download/lovelace-horizon-card.js) file.
1. If necessary, create a `www` folder in your configuration folder (where `configuration.yaml` is found).
1. Copy the downloaded file into your `www` folder.
Expand Down

0 comments on commit 761d182

Please sign in to comment.