Skip to content

Commit

Permalink
🔖 Update version & docs (v0.8.0)
Browse files Browse the repository at this point in the history
  • Loading branch information
kalkih committed May 11, 2020
1 parent c3ff186 commit 422e865
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 27 deletions.
40 changes: 14 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ A minimalistic weather card for [Home Assistant](https://github.com/home-assista

## Install

### Simple install

*This card is available in [HACS](https://github.com/custom-components/hacs) (Home Assistant Community Store)*

### Manual install

1. Download and copy `simple-weather-card-bundle.js` from the [latest release](https://github.com/kalkih/simple-weather-card/releases/latest) into your `config/www` directory.

2. Add a reference to `simple-weather-card-bundle.js` inside your `ui-lovelace.yaml` or through the raw config editor interface.

```yaml
resources:
- url: /local/simple-weather-card-bundle.js?v=0.7.2
- url: /local/simple-weather-card-bundle.js?v=0.8.0
type: module
```
Expand All @@ -30,29 +30,17 @@ A minimalistic weather card for [Home Assistant](https://github.com/home-assista
2. Download `simple-weather-card-bundle.js`

```console
$ wget https://github.com/kalkih/simple-weather-card/releases/download/v0.7.2/simple-weather-card-bundle.js
$ wget https://github.com/kalkih/simple-weather-card/releases/download/v0.8.0/simple-weather-card-bundle.js
```

3. Add a reference to `simple-weather-card-bundle.js` inside your `ui-lovelace.yaml` or through the raw config editor gui.

```yaml
resources:
- url: /local/simple-weather-card-bundle.js?v=0.7.2
- url: /local/simple-weather-card-bundle.js?v=0.8.0
type: module
```

### *(Optional)* Add to custom updater

1. Make sure you've the [custom_updater](https://github.com/custom-components/custom_updater) component installed and working.

2. Add a new reference under `card_urls` in your `custom_updater` configuration in `configuration.yaml`.

```yaml
custom_updater:
card_urls:
- https://raw.githubusercontent.com/kalkih/simple-weather-card/master/tracker.json
```

## Updating
1. Find your `simple-weather-card-bundle.js` file in `config/www` or wherever you ended up storing it.

Expand All @@ -62,7 +50,7 @@ A minimalistic weather card for [Home Assistant](https://github.com/home-assista

```yaml
resources:
- url: /local/simple-weather-card-bundle.js?v=0.7.2
- url: /local/simple-weather-card-bundle.js?v=0.8.0
type: module
```

Expand Down Expand Up @@ -109,7 +97,14 @@ See [Backdrop example](#backdrop-example) for example usage.
See [Custom example](#custom-sensors-example) for example usage.
Possible entries are: `temp`, `high`, `low`, `state`, `precipitation`, `humidity`, `icon-state`, `wind_speed`, `wind_bearing`, `pressure` & `precipitation_probability`.

#### action object options
```yaml
custom:
- temp: sensor.home_temp
- high: sensor.home_high_temp
- low: sensor.home_low_temp
```

#### Action object options

| Name | Type | Default | Options | Description |
|------|------|---------|-------------|-------------|
Expand All @@ -119,13 +114,6 @@ Possible entries are: `temp`, `high`, `low`, `state`, `precipitation`, `humidity
| navigation_path | string | none | Any path | Path to navigate to (e.g. `/lovelace/0/`) when `action` is defined as `navigate`
| entity | string | none | Any entity id | Override default entity of more-info, when `action` is defined as `more-info`

```yaml
custom:
- temp: sensor.home_temp
- high: sensor.home_high_temp
- low: sensor.home_low_temp
```


### Example usage

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "simple-weather-card",
"version": "0.7.2",
"version": "0.8.0",
"description": "A minimalistic and customizable graph card for Home Assistant Lovelace UI",
"keywords": [
"home-assistant",
Expand Down

0 comments on commit 422e865

Please sign in to comment.