Skip to content
This repository has been archived by the owner on Mar 10, 2023. It is now read-only.

Commit

Permalink
Merge pull request #18 from AitorDB/feature/update-readme
Browse files Browse the repository at this point in the history
Update readme with missing changes
  • Loading branch information
AitorDB authored May 17, 2021
2 parents f36551e + 01e680b commit 9e54b2f
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# Homeassistant sun card
Home assistant sun card based on Google weather design
# Home assistant Sun card
Home assistant Sun card based on Google weather design

## Preview
![image](https://user-images.githubusercontent.com/6829526/118412152-54d93900-b690-11eb-8b2b-e87b4cbcca7f.png)
![image](https://user-images.githubusercontent.com/6829526/118412162-64f11880-b690-11eb-9bd7-b8c6c7d8efd8.png)

## Install
### HACS
1. Go to `HACS > Frontend` and click on settings (3 dots in the top right corner) and click on custom repositories.
1. Add `https://github.com/AitorDB/home-assistant-sun-card` as URL and choose Lovelace as category.
Home assistant Sun card is available by default on HACS directory. More info [here](https://hacs.xyz/).

### Manually
1. Download the `home-assistant-sun-card.js` file from the latest release available and save it in your `configuration/www` folder.
Expand All @@ -20,14 +19,16 @@ Home assistant sun card based on Google weather design
Note: If `Custom: Sun card` doesn't appear you will have to reload cleaning the cache.

## Config
| Name | Accepted values | Description | Default |
|---------------|-----------------|--------------------------------------|-----------------------------------------------------|
| darkMode | `boolean` | Changes card colors to dark or light | Home assistant dark mode state |
| language | `'es'`/`'en'` | Changes card language | Home assistant language or english if not supported |
| showAzimuth | `boolean` | Displays azimuth in the footer | `false` |
| showElevation | `boolean` | Displays elevation in the footer | `false` |
| timeFormat | `'12h'`/`'24h'` | Displayed time format | Locale based on Home assistant language |
| title | `string` | Card title | Doesn't display a title by default | |
| Name | Accepted values | Description | Default |
|---------------|----------------------|--------------------------------------|-----------------------------------------------------|
| darkMode | `boolean` | Changes card colors to dark or light | Home assistant dark mode state |
| language | `string`<sup>1</sup> | Changes card language | Home assistant language or english if not supported |
| showAzimuth | `boolean` | Displays azimuth in the footer | `false` |
| showElevation | `boolean` | Displays elevation in the footer | `false` |
| timeFormat | `'12h'`/`'24h'` | Displayed time format | Locale based on Home assistant language |
| title | `string` | Card title | Doesn't display a title by default | |

(<sup>1</sup>) Supported languages: `de`, `en`, `es`, `fi`, `fr`, `hu`, `it`, `nl`, `pt-BR`

## Known issues
- Home assistant seems to provide next events instead today's one

0 comments on commit 9e54b2f

Please sign in to comment.