diff --git a/README.md b/README.md index bd9be9d7..fa39ba4b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# HASP - Open Hardware edition +# openHASP firmware [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/HASwitchPlate/openHASP/PlatformIO%20CI?label=build%20status&logo=github&logoColor=%23dddddd)](https://github.com/HASwitchPlate/openHASP/actions) [![GitHub release](https://img.shields.io/github/v/release/HASwitchPlate/openHASP?include_prereleases)](https://github.com/HASwitchPlate/openHASP/releases) @@ -10,10 +10,10 @@ Control your home-automation devices from a customizable touchscreen UI connected via MQTT. This project is a re-implementation of the popular HASwitchPlate sketch created by aderusha. -The [original HASwitchPlate][1] project uses a Wemos D1 mini and requires a Nextion/TJC HMI display. -This rewrite removes the Nextion/TJC requirement by using the [Light and Versatile Graphics Library][2] on the MCU to drive a cheap commodity display. +The [HASPone][1] project uses a Wemos D1 mini and requires a Nextion/TJC HMI display. +This rewrite removes the Nextion/TJC hardware requirement by using the [Light and Versatile Graphics Library][2] on the MCU to drive a commodity display. -This version also adds ESP32 and STM32F4 support to take advantage of the additional hardware capabilities. +openHASP also adds ESP32 and STM32F4 support to take advantage of the additional hardware capabilities. ## Demo Screens @@ -57,13 +57,13 @@ To build a defierent branch use: ```bash git clone --recursive https://github.com/HASwitchPlate/openHASP cd openHASP -git checkout 0.1.0-dev +git checkout 0.4.0 git submodule update --init --recursive ``` ## Getting Started -Check out the [documentation](https://fvanroie.github.io/hasp-docs/) for how-to's, information and frequently asked questions. +Check out the [documentation](https://haswitchplate.github.io/openHASP-docs/) for how-to's, information and frequently asked questions. Support --------------------------- @@ -71,7 +71,7 @@ For support using openHASP, please join the [#openHASP channel][6] on Discord. -[1]: https://github.com/aderusha/HASwitchPlate +[1]: https://github.com/HASwitchPlate/HASPone [2]: https://github.com/lvgl/lvgl [3]: https://littlevgl.com/themes [4]: https://github.com/fvanroie/HMI-Font-Pack/releases