From 6ce90b3d65e83b1e9e6227f9a25398076edbb339 Mon Sep 17 00:00:00 2001 From: Ben Tomlin Date: Tue, 9 Apr 2019 00:39:15 +0200 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 134b0df..867df27 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,20 @@ Simple card for Xiaomi robot vaccums in Home Assistant's Lovelace UI ### Setup -Add [xiaomi-vacuum-card.js](https://raw.githubusercontent.com/benct/lovelace-xiaomi-vacuum-card/master/xiaomi-vacuum-card.js) to your `/www/` folder. -If you want to use the vacuum background image, add [img/vacuum.png](https://raw.githubusercontent.com/benct/lovelace-xiaomi-vacuum-card/master/img/vacuum.png) to `/www/img/`. -Add the following to your `ui-lovelace.yaml` file: +Add [xiaomi-vacuum-card.js](https://raw.githubusercontent.com/benct/lovelace-xiaomi-vacuum-card/master/xiaomi-vacuum-card.js) to your `/www/` folder. Add the following to your `ui-lovelace.yaml` file: ```yaml resources: - url: /local/xiaomi-vacuum-card.js type: js ``` +If you want to use the vacuum background image, add [img/vacuum.png](https://raw.githubusercontent.com/benct/lovelace-xiaomi-vacuum-card/master/img/vacuum.png) to `/www/img/`. ### Options | Name | Type | Default | Description | ---- | ---- | ------- | ----------- -| type | string | **Required** | `custom:multiple-entity-row` +| type | string | **Required** | `custom:xiaomi-vacuum-card` | entity | string | **Required** | `vacuum.my_xiaomi_vacuum` | background | string/bool | `img/vacuum.png` | Custom path/name of background image (set to false to disable background) | buttons | bool | `true` | Set to false to hide button row @@ -26,7 +25,13 @@ resources: ### Examples ![xiaomi-vacuum-card](https://raw.githubusercontent.com/benct/lovelace-xiaomi-vacuum-card/master/examples/default.png) + +Hidden button row + ![xiaomi-vacuum-card-no-buttons](https://raw.githubusercontent.com/benct/lovelace-xiaomi-vacuum-card/master/examples/no-buttons.png) + +No background image + ![xiaomi-vacuum-card-no-background](https://raw.githubusercontent.com/benct/lovelace-xiaomi-vacuum-card/master/examples/no-background.png) ```yaml