Skip to content

Commit 3bb243c

Browse files
authored
Update README.md
Aligned markdown with HASS.Agent
1 parent 71682c3 commit 3bb243c

File tree

1 file changed

+25
-16
lines changed

1 file changed

+25
-16
lines changed

README.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,34 @@ This <a href="https://www.home-assistant.io" target="_blank">Home Assistant</a>
88

99
Note: it won't be of much use if you don't have HASS.Agent installed & configured on at least one device.
1010

11-
Contents
12-
========
11+
----
12+
13+
### Contents
1314

1415
* [Functionality](#functionality)
1516
* [Installation](#installation)
1617
* [Configuration](#configuration)
1718
* [Usage](#usage)
1819
* [Wishlist](#wishlist)
20+
* [License](#license)
21+
22+
----
1923

20-
Functionality
21-
---
24+
### Functionality
2225

2326
Currently, it's possible to send normal (text-based) and image notifications.
2427

28+
----
2529

26-
Installation
27-
---
30+
### Installation
2831

2932
The easiest way to install is to use <a href="https://hacs.xyz" target="_blank">HACS</a>. Simply search for **HASS.Agent Notifier**, install and restart Home Assistant.
3033

3134
If you want to manually install, copy the `hass_agent_notifier` folder into the `config\custom_components` folder of your Home Assistant instance, and restart.
3235

36+
----
3337

34-
Configuration
35-
---
38+
### Configuration
3639

3740
This integration exposes itself as a <a href="https://www.home-assistant.io/integrations/notify/" target="_blank">notifications integration</a>, and has to be configured as such:
3841

@@ -51,11 +54,11 @@ The port needs to be open on the target device. To do so, you can run this comma
5154

5255
`netsh advfirewall firewall add rule name="HASS.Agent Notifier" dir=in action=allow protocol=TCP localport=5115`
5356

57+
----
5458

55-
Usage
56-
---
59+
### Usage
5760

58-
### General
61+
#### General
5962

6063
Currently, there are four variables you can set:
6164

@@ -64,7 +67,7 @@ Currently, there are four variables you can set:
6467
* `image`: http(s) url containing the location of an image [optional]
6568
* `duration`: duration (in seconds) for which the popup will be shown [optional]
6669

67-
### Text notification
70+
#### Text notification
6871

6972
```yaml
7073
action:
@@ -73,7 +76,7 @@ Currently, there are four variables you can set:
7376
message: "This is a test message."
7477
```
7578

76-
### Text notification with title and duration
79+
#### Text notification with title and duration
7780

7881
```yaml
7982
action:
@@ -85,7 +88,7 @@ Currently, there are four variables you can set:
8588
duration: 3
8689
```
8790

88-
### Image notification
91+
#### Image notification
8992

9093
```yaml
9194
action:
@@ -96,13 +99,19 @@ Currently, there are four variables you can set:
9699
image: "http://10.0.0.6:1234/jpeg/image.jpg"
97100
```
98101

102+
----
99103

100-
Wishlist
101-
---
104+
### Wishlist
102105

103106
List of things I want to add somewhere down the road:
104107

105108
* ability to add commands
106109
* add 'critical' type to attract more attention
107110

108111
If you have any other wishes, feel free to submit a ticket.
112+
113+
----
114+
115+
### License
116+
117+
HASS.Agent Notifier and HASS.Agent are released under the <a href="https://opensource.org/licenses/MIT" target="_blank">MIT license</a>.

0 commit comments

Comments
 (0)