diff --git a/README.md b/README.md index 65f5c57..d83facb 100644 --- a/README.md +++ b/README.md @@ -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 @@ -29,12 +29,30 @@ 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 @@ -42,6 +60,8 @@ Add a custom element in your `ui-lovelace.yaml` 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. diff --git a/VERSION b/VERSION deleted file mode 100644 index 5bc4571..0000000 --- a/VERSION +++ /dev/null @@ -1,2 +0,0 @@ -1.0.0 - diff --git a/info.md b/info.md new file mode 100644 index 0000000..fc0acac --- /dev/null +++ b/info.md @@ -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)