diff --git a/esphomeyaml-edge/README.md b/esphomeyaml-edge/README.md index 997a911fcd..7fc7069374 100644 --- a/esphomeyaml-edge/README.md +++ b/esphomeyaml-edge/README.md @@ -21,7 +21,22 @@ directly through HassIO **with no programming experience required**. All you nee is write YAML configuration files; the rest (over-the-air updates, compiling) is all handled by esphomeyaml. -![esphomeyaml dashboard screenshot](screenshot.png) +![esphomeyaml dashboard screenshot](images/screenshot.png) + +[_View the esphomeyaml documentation here_](https://esphomelib.com/esphomeyaml/index.html) + +## Example + +With esphomeyaml, you can go from a few lines of YAML straight to a custom-made +firmware. For example, to include a [DHT22](https://esphomelib.com/esphomeyaml/components/sensor/dht.html) +temperature and humidity sensor, you just need to include 8 lines of YAML +in your configuration file: + +![esphomeyaml DHT configuration example](images/dht-example.png) + +Then just click UPLOAD and the sensor will magically appear in Home Assistant: + +![esphomelib Home Assistant MQTT discovery](images/temperature-humidity.png) ## Installation diff --git a/esphomeyaml-edge/images/dht-example.png b/esphomeyaml-edge/images/dht-example.png new file mode 100644 index 0000000000..9d984cb25a Binary files /dev/null and b/esphomeyaml-edge/images/dht-example.png differ diff --git a/esphomeyaml-edge/screenshot.png b/esphomeyaml-edge/images/screenshot.png similarity index 100% rename from esphomeyaml-edge/screenshot.png rename to esphomeyaml-edge/images/screenshot.png diff --git a/esphomeyaml-edge/images/temperature-humidity.png b/esphomeyaml-edge/images/temperature-humidity.png new file mode 100644 index 0000000000..adf95ef0c7 Binary files /dev/null and b/esphomeyaml-edge/images/temperature-humidity.png differ