From d767534d319f14570ca933bc10558b3bcd40f9c3 Mon Sep 17 00:00:00 2001 From: Vivian Date: Tue, 19 Jun 2018 18:54:38 -0700 Subject: [PATCH 1/2] Separate functionalities into bullet points Changing format improves readability. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f0765d4..6855a14 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # GarHAge -## a Home-Automation-friendly ESP8266-based MQTT Garage Door Controller +## A Home-Automation-friendly ESP8266-based MQTT Garage Door Controller -GarHAge allows two "dumb" garage door openers to be controlled (open/close) and report garage door status (open/closed) via MQTT. +GarHage has two main functionalities: +1. Allows 2 "dumb" garage door openers to be controlled (open/close) +2. Report garage door status (opened/closed) via MQTT GarHAge is almost completely compatible with Home Assistant's "MQTT Cover" platform. It responds to HASS's open and close commands and reports door status to keep HASS's GUI in sync with the door state. GarHAge does not implement HASS's "stop" command (as this functionality varies between garage door openers) or "tilt" functionality. Sample HASS configuration snippets are provided in this repository to get your garage door openers connected to HASS as quickly and painlessly as possible. From 72c19b8841270ea47956cc777333d79ebb50af23 Mon Sep 17 00:00:00 2001 From: Vivian Date: Tue, 19 Jun 2018 22:04:35 -0700 Subject: [PATCH 2/2] fix grammatical error --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6855a14..aa15cf5 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ GarHage has two main functionalities: 1. Allows 2 "dumb" garage door openers to be controlled (open/close) -2. Report garage door status (opened/closed) via MQTT +2. Reports garage door status (opened/closed) via MQTT GarHAge is almost completely compatible with Home Assistant's "MQTT Cover" platform. It responds to HASS's open and close commands and reports door status to keep HASS's GUI in sync with the door state. GarHAge does not implement HASS's "stop" command (as this functionality varies between garage door openers) or "tilt" functionality. Sample HASS configuration snippets are provided in this repository to get your garage door openers connected to HASS as quickly and painlessly as possible.