Files
mushroom-strategy/README.md
T

88 lines
2.6 KiB
Markdown
Raw Normal View History

2023-03-26 19:00:59 -04:00
# Mushroom dashboard strategy
2023-06-14 07:29:18 +02:00
[![release][releaseBadge]][releaseUrl]
2023-11-22 21:02:56 +01:00
[![hacs][hacsBadge]][hacsUrl]
2023-03-26 19:00:59 -04:00
2023-04-04 12:46:59 -04:00
![Preview GIF](./docs/preview.gif)
2023-03-28 12:55:49 -04:00
2023-11-22 21:02:56 +01:00
<details>
<summary>More images...</summary>
2023-03-26 19:00:59 -04:00
![Automatic](./docs/auto.png)
![Views](./docs/views.png)
2023-03-27 18:20:42 -04:00
![customizable](./docs/customizable.png)
2023-11-22 21:02:56 +01:00
</details>
2023-03-26 19:00:59 -04:00
2023-11-22 21:02:56 +01:00
## What is the Mushroom Dashboard Strategy?
2023-03-26 19:00:59 -04:00
2025-04-26 09:04:33 +02:00
Mushroom Dashboard Strategy provides a strategy for Home Assistant to automatically generate a dashboard
using [Mushroom][mushroomUrl] cards.
2023-03-26 19:00:59 -04:00
2025-04-26 09:04:33 +02:00
Dashboard cards are generated for your Home Assistant's entities, devices and areas, divided over several views.
Starting at the Home view, you can enter an area subview.
For easy access, separate views are generated for entities which belong to specific domains.
2023-03-28 01:48:41 -04:00
2023-03-26 19:00:59 -04:00
### Features
2025-04-26 09:04:33 +02:00
- 🛠 Automatically create a dashboard with three lines of YAML.
2023-06-14 07:29:18 +02:00
- 😍 Built-in Views for device-specific controls.
- 🎨 Many options to customize to fit your needs.
2025-04-26 09:04:33 +02:00
- 📈 [Mini graph][miniGraphUrl] cards for sensor entities.
2023-03-26 19:00:59 -04:00
2023-11-22 21:02:56 +01:00
> [!TIP]
2025-04-26 09:04:33 +02:00
> If you like this package, please star the [project at GitHub][repositoryUrl]!
2023-03-28 01:40:59 -04:00
2023-11-22 21:02:56 +01:00
## Getting started
2023-03-28 01:23:26 -04:00
2023-11-22 21:02:56 +01:00
The strategy is easily installable from [HACS][hacsUrl] (Home Assistant Community Store).
2025-04-26 09:04:33 +02:00
Please visit [Installation Guide][installationUrl] at our Wiki.
2023-06-14 07:29:18 +02:00
2023-11-22 21:02:56 +01:00
## Need some help?
2023-03-28 01:23:26 -04:00
2025-04-26 09:04:33 +02:00
Visit the [Discussions][discussionsUrl] page or
the [Wiki][wikiUrl].
2023-03-26 19:00:59 -04:00
2023-11-22 21:02:56 +01:00
## Have an idea or want to report a bug?
2023-03-26 19:00:59 -04:00
2023-11-22 21:02:56 +01:00
Make sure your idea or bug isn't discussed already in our Discussions or Issues!
2025-04-26 09:04:33 +02:00
Visit the [issues][issuesUrl] page.
2023-03-26 19:00:59 -04:00
2025-04-26 09:04:33 +02:00
## Collaborators
2023-03-26 19:00:59 -04:00
2023-06-14 07:29:18 +02:00
* [DigiLive](https://github.com/DigiLive)
2023-11-22 21:02:56 +01:00
[![Sponsor DigiLive][sponsorBadge]](https://github.com/sponsors/DigiLive)
2025-04-26 09:04:33 +02:00
* [Aalian Khan](https://github.com/AalianKhan)
2023-06-14 07:29:18 +02:00
2023-11-22 21:02:56 +01:00
<!-- Badge References -->
[hacsBadge]: https://img.shields.io/badge/HACS-Default-blue
[sponsorBadge]: https://img.shields.io/badge/Sponsor_him-%E2%9D%A4-%23db61a2.svg?&logo=github&color=%23fe8e86
2025-04-26 09:04:33 +02:00
[releaseBadge]: https://img.shields.io/badge/Release-v2.3.0-alpha.1-blue
<!-- Repository References -->
[repositoryUrl]: https://github.com/DigiLive/mushroom-strategy
[releaseUrl]: https://github.com/DigiLive/mushroom-strategy/releases/tag/v2.3.0-alpha.1
[issuesUrl]: https://github.com/DigiLive/mushroom-strategy/issues
[discussionsUrl]: https://github.com/DigiLive/mushroom-strategy/discussions
[wikiUrl]: https://github.com/DigiLive/mushroom-strategy/wiki
[installationUrl]: https://github.com/DigiLive/mushroom-strategy/wiki#installation
2023-06-14 07:29:18 +02:00
<!-- Other References -->
[hacsUrl]: https://hacs.xyz
[mushroomUrl]: https://github.com/piitaya/lovelace-mushroom
2023-11-22 21:02:56 +01:00
[miniGraphUrl]: https://github.com/kalkih/mini-graph-card