diff --git a/README.md b/README.md index 244bdb1..8da65e5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # ESPUI -![ESPUI Dashboard](https://github.com/s00500/ESPUI/blob/master/docs/img1.PNG) +![ESPUI Controlpad](https://github.com/s00500/ESPUI/blob/master/docs/controlpad.png) +![ESPUI Switch](https://github.com/s00500/ESPUI/blob/master/docs/switch.png) + ESPUI is a simple library to make a web user interface for your projects using the **ESP32** It uses web sockets and lets you create, control, and update elements on your GUI through multiple devices like phones and tablets. @@ -51,9 +53,9 @@ This library is dependent on the following libraries to function properly. ## User interface Elements - - Label (update able) + - Label (updateable) - Button - - Switch (update able) + - Switch (updateable) - Control pad - Control pad with center button @@ -61,16 +63,17 @@ This library is dependent on the following libraries to function properly. ## Roadmap : -- Refactor id system +- refactor id system - make button colour customisable +- do a proper redesign - cleanup unnecessary CSS - gzip files to make them load faster - setup spiffs using values in program memory ? (if you have feedback to this idea let me know) -- Support ESP8266 +- ESP8266 support ## Documentation -The heart of ESPUI is +The heart of ESPUI is [ESPAsyncWebserver](https://github.com/me-no-dev/ESPAsyncWebServer). ESPUI's frontend is based on [Skeleton CSS](http://getskeleton.com/) and jQuery-like lightweight [zepto.js](https://zeptojs.com/) for Handling Click Events Etc. The communication between the *ESP32* and the client browser works using web sockets. ESPUI does not need network access and can be used in standalone access point mode. All assets are loaded from the internal SPIFFS filesystem of the ESP32. diff --git a/docs/controlpad.png b/docs/controlpad.png new file mode 100644 index 0000000..c0eb393 Binary files /dev/null and b/docs/controlpad.png differ diff --git a/docs/img1.PNG b/docs/img1.PNG deleted file mode 100644 index a8dd240..0000000 Binary files a/docs/img1.PNG and /dev/null differ diff --git a/docs/img2.PNG b/docs/img2.PNG deleted file mode 100644 index 64b365b..0000000 Binary files a/docs/img2.PNG and /dev/null differ diff --git a/docs/img3.PNG b/docs/img3.PNG deleted file mode 100644 index 595837f..0000000 Binary files a/docs/img3.PNG and /dev/null differ diff --git a/docs/img4.PNG b/docs/img4.PNG deleted file mode 100644 index 654a323..0000000 Binary files a/docs/img4.PNG and /dev/null differ diff --git a/docs/img5.PNG b/docs/img5.PNG deleted file mode 100644 index c98b109..0000000 Binary files a/docs/img5.PNG and /dev/null differ diff --git a/docs/switch.png b/docs/switch.png new file mode 100644 index 0000000..3a68179 Binary files /dev/null and b/docs/switch.png differ