Skip to content

Commit 874e48c

Browse files
authored
Update README.md
1 parent 46e0fac commit 874e48c

File tree

1 file changed

+1
-53
lines changed

1 file changed

+1
-53
lines changed

beer-card/README.md

+1-53
Original file line numberDiff line numberDiff line change
@@ -1,53 +1 @@
1-
# Beer card 🍺
2-
3-
A special card for Toast and his contribution to the community. A card that displays a multiline text in a nicer format.
4-
5-
![beer-card](https://user-images.githubusercontent.com/7738048/42560625-b7d18226-84ff-11e8-9f0a-59875edd642b.png)
6-
7-
| Name | Type | Default | Description
8-
| ---- | ---- | ------- | -----------
9-
| type | string | **Required** | `custom:beer-card`
10-
| entity | string | **Required** | The sensor to use for the list
11-
| attribute | string | `list` | The attribute of the entity to list
12-
| title | string | optional | A card title
13-
| style | string | optional | A style to apply to the `ha-card`
14-
| icon | string | `mdi:beer` | An icon to display. Besides mdi icons, it supports images: `png`, `jpg`, `svg`, `gif`
15-
| list_type | string | `none` | Style of list. Options are `none, disc, circle, square`
16-
17-
## Configuration
18-
19-
Example:
20-
```yaml
21-
- type: custom:beer-card
22-
entity: sensor.beer_list
23-
attribute: list
24-
title: Toast Beer List
25-
icon: mdi:heart
26-
list_type: disc
27-
```
28-
29-
Example with image icon:
30-
```yaml
31-
- type: custom:beer-card
32-
title: Untappd Wishlist
33-
entity: sensor.untappd_wishlist
34-
icon: /local/icons/untappd.png
35-
```
36-
37-
Example with a background image:
38-
```yaml
39-
- type: custom:beer-card
40-
title: Untappd Wishlist
41-
entity: sensor.untappd_wishlist
42-
icon: mdi:heart
43-
style: "background-image: url('/local/untapped.png')"
44-
attribute: list
45-
```
46-
47-
❤️ To activate the cards set an attribute called `list` on the `sensor.beer_list` with any state.
48-
49-
![beer-value](https://user-images.githubusercontent.com/7738048/42560596-ac2627ce-84ff-11e8-965b-b82604645086.png)
50-
51-
## Credits
52-
[ciotlosm](https://github.com/ciotlosm)
53-
[iantrich](https://github.com/iantrich)
1+
# Beer card has moved to https://github.com/custom-cards/beer-card

0 commit comments

Comments
 (0)