diff --git a/README.md b/README.md index 781994e3..47820efb 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,7 @@ All images must have the following requirements: - The image should be trimmed, so it contains the minimum amount of empty space on the edges. This includes things like white/black/any color borders or transparent spacing around the actual subject in the image. +- Custom integrations must not use Home Assistant branded images, as this might confuse the end-user into thinking that the integration is an internal/official integration. ### Icon image requirements @@ -116,7 +117,7 @@ only add the icon images. The icon will be used as a fallback for the logo. ## Using the same logo & icon for different brands To keep the size of this repository as efficient as possible, -symlinking domain folders for the same icon/logos is allowed. The deployment +symlinking domain folders for the same icon/logos is allowed for core integrations. The deployment process at our hosting provider will unpack these symlinks to actual files during the deployment process. @@ -124,6 +125,8 @@ Please note, symlinks should only be created between integration domain directories. The `_placeholder` & `_homeassistant` directories are special cases and new directories with an underscore (`_`) should not be created. +Symlinks are currently not allowed in the custom integrations folder. + The names of directories must always match the integration domain. Additional directories are not allowed.