add small yaml help on first README

gdoor-org · Jan 21, 2025 · 38b05b2 · 38b05b2
1 parent b330dba
commit 38b05b2
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -10,4 +10,15 @@ esphome-components
 │   ├── gdoor
 ```
 
+Put this in your .yaml configuration to use gdoor:
+
+```yaml
+external_components:
+  - source:
+      type: git
+      url: https://github.com/gdoor-org/esphome-components
+      ref: main           # branch
+    components: [gdoor]
+    refresh: 0s           # ensures ESPHome will grab the latest code from github on every install hit.
+```
 Keep in mind, this is still an early stage esphome-component. Any contribution /issues /comments are welcome.