From 0627f89088c70f30fa599e4d27343d9b8c4abee0 Mon Sep 17 00:00:00 2001 From: SiliconAvatar <43505983+SiliconAvatar@users.noreply.github.com> Date: Tue, 15 Sep 2020 11:19:54 -0400 Subject: [PATCH] Update readme to reflect new usage of esphome_version (#16) --- esphome-beta/README.md | 6 +++++- esphome-dev/README.md | 6 +++++- esphome/README.md | 6 +++++- template/README.md | 6 +++++- 4 files changed, 20 insertions(+), 4 deletions(-) diff --git a/esphome-beta/README.md b/esphome-beta/README.md index c4862da..8da6290 100644 --- a/esphome-beta/README.md +++ b/esphome-beta/README.md @@ -89,7 +89,11 @@ authentication by setting it to `true`. Manually override which ESPHome version to use in the add-on. For example to install the latest development version, use `"esphome_version": "dev"`, -or for version 1.14.0: `"esphome_version": "v1.14.0""`. +or for version 1.14.0: `"esphome_version": "v1.14.0"`. + +This can also be used to specify a branch of a fork of the esphome repository. +For example to install the test_new_component branch of a fork made by user123, use `"user123:test_new_component"`. +This usage assumes the forked repository is named `esphome`. Please note that this does not always work and is only meant for testing, usually the ESPHome add-on and dashboard version must match to guarantee a working system. diff --git a/esphome-dev/README.md b/esphome-dev/README.md index c4862da..8da6290 100644 --- a/esphome-dev/README.md +++ b/esphome-dev/README.md @@ -89,7 +89,11 @@ authentication by setting it to `true`. Manually override which ESPHome version to use in the add-on. For example to install the latest development version, use `"esphome_version": "dev"`, -or for version 1.14.0: `"esphome_version": "v1.14.0""`. +or for version 1.14.0: `"esphome_version": "v1.14.0"`. + +This can also be used to specify a branch of a fork of the esphome repository. +For example to install the test_new_component branch of a fork made by user123, use `"user123:test_new_component"`. +This usage assumes the forked repository is named `esphome`. Please note that this does not always work and is only meant for testing, usually the ESPHome add-on and dashboard version must match to guarantee a working system. diff --git a/esphome/README.md b/esphome/README.md index c4862da..8da6290 100644 --- a/esphome/README.md +++ b/esphome/README.md @@ -89,7 +89,11 @@ authentication by setting it to `true`. Manually override which ESPHome version to use in the add-on. For example to install the latest development version, use `"esphome_version": "dev"`, -or for version 1.14.0: `"esphome_version": "v1.14.0""`. +or for version 1.14.0: `"esphome_version": "v1.14.0"`. + +This can also be used to specify a branch of a fork of the esphome repository. +For example to install the test_new_component branch of a fork made by user123, use `"user123:test_new_component"`. +This usage assumes the forked repository is named `esphome`. Please note that this does not always work and is only meant for testing, usually the ESPHome add-on and dashboard version must match to guarantee a working system. diff --git a/template/README.md b/template/README.md index c4862da..8da6290 100644 --- a/template/README.md +++ b/template/README.md @@ -89,7 +89,11 @@ authentication by setting it to `true`. Manually override which ESPHome version to use in the add-on. For example to install the latest development version, use `"esphome_version": "dev"`, -or for version 1.14.0: `"esphome_version": "v1.14.0""`. +or for version 1.14.0: `"esphome_version": "v1.14.0"`. + +This can also be used to specify a branch of a fork of the esphome repository. +For example to install the test_new_component branch of a fork made by user123, use `"user123:test_new_component"`. +This usage assumes the forked repository is named `esphome`. Please note that this does not always work and is only meant for testing, usually the ESPHome add-on and dashboard version must match to guarantee a working system.