Skip to content

Commit 5708c5f

Browse files
Update README.md
1 parent db4f268 commit 5708c5f

File tree

1 file changed

+29
-13
lines changed

1 file changed

+29
-13
lines changed

README.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,27 @@
1-
# Overview
2-
3-
This repository contains functionality to easily generate custom dashboards with react for Home Assistant using the official web socket connection that the standard lovelace dashboards use.
4-
5-
Try it out now! [Demo](https://shannonhochkins.github.io/ha-component-kit/iframe.html?args=&id=introduction-demo--default&viewMode=story#)
6-
1+
<table>
2+
<tr>
3+
<td><img src="https://cdn.discordapp.com/icons/1231534799248691252/4b6124f952f099f855b5186d8a68f33e.webp?size=100" alt="LOGO"></td>
4+
<td><h1>HA COMPONENT KIT</h1></td>
5+
</tr>
6+
</table>
7+
<p align="left">
8+
<a aria-label="@HAKIT/CORE" href="https://www.npmjs.com/package/@hakit/core">
9+
<img alt="" src="https://img.shields.io/npm/v/@hakit/core.svg?style=for-the-badge&labelColor=000000">
10+
</a>
11+
<a aria-label="@HAKIT/COMPONENTS" href="https://www.npmjs.com/package/@hakit/components">
12+
<img alt="" src="https://img.shields.io/npm/v/@hakit/components.svg?style=for-the-badge&labelColor=000000">
13+
</a>
14+
<a aria-label="Join the community on Discord" href="https://discord.gg/agQr9JKk">
15+
<img alt="" src="https://img.shields.io/badge/Join%20the%20Discord-blueviolet.svg?style=for-the-badge&logo=Discord&labelColor=000000&logoWidth=20">
16+
</a>
17+
</p>
18+
19+
Unlock the ultimate customization for your Home Assistant dashboards with this package, leveraging React for seamless, personalized interfaces.
20+
21+
22+
## Demo
23+
24+
Visit the [Demo](https://shannonhochkins.github.io/ha-component-kit/iframe.html?args=&id=introduction-demo--default&viewMode=story#) to try it out!
725

826
If you like anything here, be sure to 🌟 [the repo!](https://github.com/shannonhochkins/ha-component-kit)
927

@@ -12,7 +30,9 @@ If you like anything here, be sure to 🌟 [the repo!](https://github.com/shanno
1230
[![@hakit/core Downloads](https://img.shields.io/npm/dt/%40hakit%2Fcore.svg?style=flat&colorA=000000&colorB=000000&label=%40hakit%2Fcore%20downloads)](https://www.npmjs.com/package/@hakit/core)
1331
[![@hakit/components Downloads](https://img.shields.io/npm/dt/%40hakit%2Fcomponents.svg?style=flat&colorA=000000&colorB=000000&label=%40hakit%2Fcomponents%20downloads)](https://www.npmjs.com/package/@hakit/components)
1432

33+
### Documentation
1534

35+
There's extensive [documentation](https://shannonhochkins.github.io/ha-component-kit) which should give you all the information you need to get started!
1636

1737
## Help me out?
1838

@@ -32,16 +52,12 @@ Or, if you want to install [@hakit/core](https://www.npmjs.com/package/@hakit/co
3252
npm install @hakit/core @hakit/components
3353
```
3454

35-
### Documentation
36-
37-
There's extensive [documentation](https://shannonhochkins.github.io/ha-component-kit) which should give you all the information you need to get started!
38-
39-
### Home Assistant Addon
55+
### Home Assistant Addon (WIP)
4056
There's a [Home Assistant Addon](ADDON.md) available which will serve your dashboard to a new sidebar link in home assistant making it easier to access your custom dashboard.
4157

4258

4359
### Supported Cards
44-
- [NEW FamilyCard](https://shannonhochkins.github.io/ha-component-kit/?path=/docs/components-cards-familycard--docs)
60+
- [FamilyCard](https://shannonhochkins.github.io/ha-component-kit/?path=/docs/components-cards-familycard--docs)
4561
- [AreaCard](https://shannonhochkins.github.io/ha-component-kit/?path=/docs/components-cards-areacard--docs)
4662
- [ButtonCard](https://shannonhochkins.github.io/ha-component-kit/?path=/docs/components-cards-buttoncard--docs)
4763
- [ClimateCard](https://shannonhochkins.github.io/ha-component-kit/?path=/docs/components-cards-climatecard--docs)
@@ -64,7 +80,7 @@ There's a [Home Assistant Addon](ADDON.md) available which will serve your dashb
6480
### What's next?
6581

6682
There's a Roadmap.md file with a few things i'm working on!
67-
Have your say! Vote for what you'd like to see next in [upcoming features!](https://github.com/shannonhochkins/ha-component-kit/discussions/28)
83+
Have your say! Join the [discord](https://discord.gg/agQr9JKk) and let me know what you'd like to see next!
6884

6985
### Contributors!
7086

0 commit comments

Comments
 (0)