From bc11331566cbae73839ced62e96ea251100df0b1 Mon Sep 17 00:00:00 2001 From: Keiran O'Leary Date: Sat, 2 Mar 2024 10:39:45 +1000 Subject: [PATCH] Update README.md --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index dbd5667..e9976c3 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,24 @@ # 🥳 Magic Home Party (Custom Card) -[![Tests](https://github.com/kizza/magic-home-party-card/actions/workflows/tests.yml/badge.svg)](https://github.com/kizza/magic-home-party-card/actions/workflows/tests.yml) +[HACS badge](https://github.com/hacs/frontend) +[Downloads badge](https://api.github.com/repos/kizza/magic-home-party-card/releases) +[Version badge](https://github.com/kizza/magic-home-party-card/releases) +[Tests badge](https://github.com/kizza/magic-home-party-card/actions/workflows/tests.yml) -A [Home Assistant](https://www.home-assistant.io/) custom card for managing the [Magic Home integration](https://www.home-assistant.io/integrations/flux_led/) lighting effects +A [Home Assistant](https://www.home-assistant.io/) custom card providing a palette for your [Magic Home integration](https://www.home-assistant.io/integrations/flux_led/) lighting effects. -Overview – Home Assistant +Overview – Home Assistant ## Motivation -I'm loving my [Magic Home integration](https://www.home-assistant.io/integrations/flux_led/) strips, and after a failed attempt and writing my own puthon _gradual transition_ effect I discovered the device can do it for me! Chooinsg (and experimenting) with the best colour combinations was awkward - going from colour wheels to yaml and back - so I made this card to make the expereince more enjoyable. +I love my [Magic Home integration](https://www.home-assistant.io/integrations/flux_led/) strips, they're inexpensive and effective. After a failed attempt and writing my own python _gradual transition_ effect I discovered the device could do it for me [with a custom effect](https://www.home-assistant.io/integrations/flux_led/#custom-effects---service-flux_ledset_custom_effect)! Choosing and experimenting with the colours was awkward though - going from colour wheels to yaml and back - so I made this card to make the experience more enjoyable. -Single clicking a colour chip will set all the configured lights to this colour - then double clicking any will add it to the sequence. +Single-clicking a colour chip from the palette will set all your configured lights to this colour - double-clicking any will add it to the sequence. ## Installation +Magic Home Logo +Configure your Magic Home lights as per normal in homeassistant. If you don't recognise this logo, this integration may not target your lights. + ### HACS Magic Home Party Card is available in [HACS][hacs] (Home Assistant Community Store). @@ -36,4 +42,4 @@ Magic Home Party Card is available in [HACS][hacs] (Home Assistant Community Sto ## Usage -Once installed you should find it within your available cards. Add-and-remove selected colors by double clicking (single click turns lights to that colour to see it). Once setup, click anywhere on the card to run the [magic light effect](https://www.home-assistant.io/integrations/flux_led/#custom-effects---service-flux_ledset_custom_effect) with your selected colours on your selected lights. +Once installed you should find it within your available dashboard cards. Add-and-remove selected colors by double clicking (single click previews that colour with your lights). Once setup, click anywhere on the card to run the [magic light effect](https://www.home-assistant.io/integrations/flux_led/#custom-effects---service-flux_ledset_custom_effect) with your configuration.