Skip to content

Commit

Permalink
🎉 Made this card HACS compatible (#2)
Browse files Browse the repository at this point in the history
* Deleted VERSION

It's not needed for HACS

* Added info.md file

This will contain the extra information for HACS.

* Updated the README.md to include HACS installation
  • Loading branch information
ping-localhost authored Aug 27, 2019
1 parent 5869538 commit effa8e4
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 4 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This card give you a list of shipment information generated by the official [17t
| entity | string | **Required** | The entity_id of the entity you want to show (for example, `sensor.seventeentrack_packages_in_transit`).
| title | string | **Optional** | Add a custom title to the card.

## Installation
## Manual installation

### Step 1

Expand All @@ -29,19 +29,39 @@ Link `seventeen-track-card` inside you `ui-lovelace.yaml`.

```yaml
resources:
- url: /local/seventeen-track-card.js?v=1.0
- url: /local/seventeen-track-card.js
type: js
```
## HACS installation
### Step 1
Install HACS as per there [Installation guide](https://hacs.netlify.com/installation/manual/).
### Step 2
Add my repository as a custom repostiory in the HACS settings (and be sure to select the `Plugin`-category).

### Step 3

Install the card as you are used to and set it up as instructed by HACS, which consists of adding:
``` yml
- url: /community_plugin/seventeen-track-card/seventeen-track-card.js
type: js
```

### Step 4

Add a custom element in your `ui-lovelace.yaml`

```yaml
- type: custom:seventeen-track-card
entity: sensor.seventeentrack_packages_in_transit
```

# Final result

![example](example.png)

**Suggestion**: If you set a "memo" in 17Track, it will be displayed in the frontend as well.
2 changes: 0 additions & 2 deletions VERSION

This file was deleted.

16 changes: 16 additions & 0 deletions info.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Description

Seventeen Track Card is customizable card for the Home Assistant Lovelace front-end. It allows you to show what packages are currently in transit.

## Options

| Name | Type | Requirement | Description
| ---- | ---- | ------- | -----------
| type | string | **Required** | `custom:seventeen-track-card`
| entity | string | **Required** | The entity_id of the entity you want to show (for example, `sensor.seventeentrack_packages_in_transit`).
| title | string | **Optional** | Add a custom title to the card.


## Example

![](https://github.com/ping-localhost/seventeen-track-card/blob/master/example.png?raw=true)

0 comments on commit effa8e4

Please sign in to comment.