From 8c4f87cde288f06de886822b050636cfb73da16b Mon Sep 17 00:00:00 2001 From: "Daniel W. Anner" Date: Fri, 24 Mar 2023 16:55:30 -0400 Subject: [PATCH] Update README.md Added front and rear image definition --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 37854aefb..e4193a6f8 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,14 @@ The following fields may **optionally** be declared: - `side-to-rear` - `passive` > :test_tube: **Example**: `airflow: side-to-rear` +- `front_image`: Indicates that this device has a front elevation image within the elevation-imgaes folder. (**Default: None**) + - NOTE: The elevation images folder requires the same folder name as this device. The file name must also adhere to .front. + - Type: Boolean +> :test_tube: **Example**: `front_image: True` +- `rear_image`: Indicates that this device has a rear elevation image within the elevation-imgaes folder. (**Default: None**) + - NOTE: The elevation images folder requires the same folder name as this device. The file name must also adhere to .rear. + - Type: Boolean +> :test_tube: **Example**: `rear_image: False` - `subdevice_role`: Indicates that this is a `parent` or `child` device. (**Default: None**) - Type: String - Options: