From e6a114ac5b3acccfbca664d8cfcf8b3c4d3b13b4 Mon Sep 17 00:00:00 2001 From: Andrew Jackson Date: Sun, 16 Mar 2025 19:57:04 +0000 Subject: [PATCH] Add details of dark variants to readme (#6751) * Add details of dark variants * Revert to original formatting --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2516c15f..0cc80f35 100644 --- a/README.md +++ b/README.md @@ -22,23 +22,35 @@ Each of these two main folders contain domain folders. Each domain folder is named to the integration `domain` and must match the domain set in the integration `manifest.json` file. -A domain folder can contain four files: +A domain folder can contain eight files: - `icon.png`: A square avatar-like icon, representing the brand or product for that domain. +- `dark_icon.png`: Dark optimised icon (if required). - `logo.png`: The logo of the brand or product for that domain. +- `dark_logo.png`: Dark optimised logo (if required). - `icon@2x.png`: hDPI version of `icon.png` +- `dark_icon@2x.png`: hDPI version of `dark_icon.png` - `logo@2x.png`: hDPI version of `logo.png` +- `dark_logo@2x.png`: hDPI version of `dark_logo.png` Those images are served in the following format: - `https://brands.home-assistant.io/[domain]/icon.png` +- `https://brands.home-assistant.io/[domain]/dark_icon.png` - `https://brands.home-assistant.io/[domain]/logo.png` +- `https://brands.home-assistant.io/[domain]/dark_logo.png` - `https://brands.home-assistant.io/[domain]/icon@2x.png` +- `https://brands.home-assistant.io/[domain]/dark_icon@2x.png` - `https://brands.home-assistant.io/[domain]/logo@2x.png` +- `https://brands.home-assistant.io/[domain]/dark_logo@2x.png` - `https://brands.home-assistant.io/_/[domain]/icon.png` +- `https://brands.home-assistant.io/_/[domain]/dark_icon.png` - `https://brands.home-assistant.io/_/[domain]/logo.png` +- `https://brands.home-assistant.io/_/[domain]/dark_logo.png` - `https://brands.home-assistant.io/_/[domain]/icon@2x.png` +- `https://brands.home-assistant.io/_/[domain]/dark_icon@2x.png` - `https://brands.home-assistant.io/_/[domain]/logo@2x.png` +- `https://brands.home-assistant.io/_/[domain]/dark_logo@2x.png` ### Missing image handling @@ -72,7 +84,7 @@ For example: <`https://brands.home-assistant.io/_/[domain]/icon.png`> All icons and logos are cached by browsers for 7 days, so additions and changes may take time to reach all users. This gives users the full benefits of local caching with minimal revalidation, and protects against missing content during an internet outage. -Images are simultaneously cached by Cloudflare for 24 hours. This allows changes to begin being distributed to users relatively quickly without losing the CDN benefits. It also guarantees a simple refresh (F5) will bring content no more than 1 day old. +Images are simultaneously cached by Cloudflare for 24 hours. This allows changes to begin being distributed to users relatively quickly without losing the CDN benefits. It also guarantees a simple refresh (F5) will bring content no more than 1 day old. The Cloudflare cache is also fully flushed in each major version of Home Assistant Core.