Skip to content

Commit 97ee90d

Browse files
committed
Update readme
1 parent 3238577 commit 97ee90d

File tree

2 files changed

+26
-12
lines changed

2 files changed

+26
-12
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,12 @@ However, snarky-snark's `var` [component](https://github.com/snarky-snark/home-a
77
Plus, I borrowed some code and inspiration from [benct's](https://github.com/benct) awesome [Xiaomi Vacuum Card](https://github.com/benct/lovelace-xiaomi-vacuum-card) - many thanks for that one, Ben!
88

99

10-
[![release](https://img.shields.io/github/v/release/faeibson/lovelace-multiline-text-input-card)](https://github.com/faeibson/lovelace-multiline-text-input-card/releases)
11-
[![code_size](https://img.shields.io/github/languages/code-size/faeibson/lovelace-multiline-text-input-card)]()
12-
![license](https://img.shields.io/github/license/faeibson/lovelace-multiline-text-input-card)
13-
[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/hacs/integration)
10+
[![release](https://img.shields.io/github/v/release/faeibson/lovelace-multiline-text-input-card?style=flat-square)](https://github.com/faeibson/lovelace-multiline-text-input-card/releases)
11+
![code_size](https://img.shields.io/github/languages/code-size/faeibson/lovelace-multiline-text-input-card?style=flat-square)
12+
![license](https://img.shields.io/github/license/faeibson/lovelace-multiline-text-input-card?style=flat-square)
13+
[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg?style=flat-square)](https://github.com/hacs/integration)
14+
15+
![Screenshot](https://raw.githubusercontent.com/faeibson/lovelace-multiline-text-input-card/master/screenshot.png)
1416

1517
## Setup
1618

@@ -44,7 +46,7 @@ resources:
4446
| buttons | object/bool | *(see below)* | Set to `false` to hide button row
4547
| icons | object | *(see below)* | Set custom button icons (same keys as `buttons` object)
4648

47-
*\* Note: If necessary, the entity's min/max length attributes will be taken into account and overwrite the config.*
49+
(*) Note: If necessary, the entity's min/max length attributes will be taken into account and overwrite the config.
4850

4951
### Buttons object
5052

@@ -54,7 +56,7 @@ resources:
5456
| paste | bool | `true` | Show or hide clipboard paste button (*)
5557
| clear | bool | `true` | Show or hide clear button
5658

57-
*\* Note: Clipboard paste does not work in all browsers!*
59+
(*) Note: Clipboard paste does not work in all browsers!
5860

5961
### Icons object
6062

@@ -68,8 +70,6 @@ resources:
6870

6971
Don't forget to add your `input_text` or `var` entity in your `configuration.yaml`! ;)
7072

71-
![Screenshot](https://raw.githubusercontent.com/faeibson/lovelace-multiline-text-input-card/master/screenshot.png)
72-
7373
### Simple config example:
7474
```yaml
7575
- type: custom:lovelace-multiline-text-input-card

info.md

+18-4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
# multiline-text-input-card
2+
3+
This is a simple lovelace card to display a multiline text input field bound on an `input_text` or `var` entity.
4+
5+
However, snarky-snark's `var` [component](https://github.com/snarky-snark/home-assistant-variables/) is recommended to use since Home Assistant's `input_text` is limited to a maximum of only 255 characters. At this point I will not forget to mention that this great component is capable of so much more - have a look at it!
6+
7+
Plus, I borrowed some code and inspiration from [benct's](https://github.com/benct) awesome [Xiaomi Vacuum Card](https://github.com/benct/lovelace-xiaomi-vacuum-card) - many thanks for that one, Ben!
8+
9+
10+
[![release](https://img.shields.io/github/v/release/faeibson/lovelace-multiline-text-input-card)](https://github.com/faeibson/lovelace-multiline-text-input-card/releases)
11+
![code_size](https://img.shields.io/github/languages/code-size/faeibson/lovelace-multiline-text-input-card)
12+
![license](https://img.shields.io/github/license/faeibson/lovelace-multiline-text-input-card)
13+
[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/hacs/integration)
14+
15+
![Screenshot](https://raw.githubusercontent.com/faeibson/lovelace-multiline-text-input-card/master/screenshot.png)
16+
117
## Options
218

319
| Name | Type | Default | Description
@@ -13,7 +29,7 @@
1329
| buttons | object/bool | *(see below)* | Set to `false` to hide button row
1430
| icons | object | *(see below)* | Set custom button icons (same keys as `buttons` object)
1531

16-
*\* Note: If necessary, the entity's min/max length attributes will be taken into account and overwrite the config.*
32+
(*) Note: If necessary, the entity's min/max length attributes will be taken into account and overwrite the config.
1733

1834
### Buttons object
1935

@@ -23,7 +39,7 @@
2339
| paste | bool | `true` | Show or hide clipboard paste button (*)
2440
| clear | bool | `true` | Show or hide clear button
2541

26-
*\* Note: Clipboard paste does not work in all browsers!*
42+
(*) Note: Clipboard paste does not work in all browsers!
2743

2844
### Icons object
2945

@@ -37,8 +53,6 @@
3753

3854
Don't forget to add your `input_text` or `var` entity in your `configuration.yaml`! ;)
3955

40-
![Screenshot](https://raw.githubusercontent.com/faeibson/lovelace-multiline-text-input-card/master/screenshot.png)
41-
4256
### Simple config example:
4357
```yaml
4458
- type: custom:lovelace-multiline-text-input-card

0 commit comments

Comments
 (0)