Skip to content

Commit 21e48e0

Browse files
committed
Merge branch 'main' of https://github.com/addyire/ha-menu
2 parents 127c589 + a39a1ae commit 21e48e0

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

README.md

+15-16
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# ha-menu
2-
<img src="https://img.shields.io/github/stars/addyire/ha-menu?style=plastic">
3-
<img src="https://img.shields.io/badge/contributions-welcome-brightgreen">
4-
<br>
2+
<img src="https://img.shields.io/github/stars/addyire/ha-menu?style=badge"> <img src="https://img.shields.io/badge/contributions-welcome-brightgreen"><br>
53
An **insanely** customizable way to interact with Home Assistant in the menubar
64

75
<img src="img/preview.png" width=800>
@@ -12,8 +10,9 @@ An **insanely** customizable way to interact with Home Assistant in the menubar
1210
- [App Configuration](#app-configuration)
1311
- [Menubar Configuration](#menubar-configuration)
1412
- [Menu Item Types](#menu-item-types)
15-
- [Icons](#icons)
16-
- [Templating](#templating)
13+
- [MenuAction](#menuaction)
14+
- [Icons](#icons)
15+
- [Templating](#templating)
1716

1817
# Installation
1918

@@ -175,7 +174,7 @@ Looks like a label but opens Home Assistant in your browser when clicked.
175174
* **required** `label` {`String`}: The label for this item
176175
* `icon` {`String`}: The icon name for this item
177176

178-
# `MenuAction`
177+
## MenuAction
179178

180179
A `MenuAction` is how you can interact with Home Assistant.
181180

@@ -194,7 +193,7 @@ A `MenuAction` is how you can interact with Home Assistant.
194193
}
195194
```
196195

197-
# Icons
196+
## Icons
198197

199198
To add an icon to your Menu Bar follow these steps
200199

@@ -208,7 +207,7 @@ To add an icon to your Menu Bar follow these steps
208207
* Make the size of your image `32x32`
209208
* Add `@2x` to the end of your file name to make it a "High Resolution Image" (Read below for more information)
210209

211-
## High Resolution Image
210+
### High Resolution Image
212211

213212
To make your image look better in the Menubar you can make it "High Resolution" which increases the DPI. Here are the following options:
214213

@@ -229,37 +228,37 @@ Just add one of these to the end of your file.
229228
#### Example
230229
`icon.png` -> `[email protected]`
231230

232-
## Icon Templates
231+
### Icon Templates
233232

234233
It is recommended that your icons are made a template. To make your icon a template
235234

236235
* Your image **must** be only black pixels with a transparent background
237236
* Add `Template` to the end of the name of your file.
238237

239-
## File Name Examples
238+
### File Name Examples
240239

241240
* `icon.png` -> `iconTemplate.png`
242241
243242

244-
## [More Information Here](https://www.electronjs.org/docs/latest/api/native-image#high-resolution-image)
243+
### [More Information Here](https://www.electronjs.org/docs/latest/api/native-image#high-resolution-image)
245244

246-
# Templating
245+
## Templating
247246

248247
**The customization is not over!** You can also use Home Assistant Templates in certain fields!
249248

250-
## Supported Fields
249+
### Supported Fields
251250

252251
* `label`
253252
* `icon`
254253
* `title`
255254

256-
## Converting To Templates
255+
### Converting To Templates
257256

258257
To make a field a template just add `Template` to the end of the field name and put your template in the value.
259258

260-
## Example
259+
#### Example
261260
```json
262261
{
263262
"labelTemplate": "{{ states('light.my_light') }}"
264263
}
265-
```
264+
```

0 commit comments

Comments
 (0)