From eff0985c7204315aa07b0d153387e40bd217ddcc Mon Sep 17 00:00:00 2001
From: Hendrik Schutter <localhorst@mosad.xyz>
Date: Thu, 5 Nov 2020 08:34:21 +0100
Subject: [PATCH] updated readme

---
 README.md | 32 ++++++++++++++++++++++++++++----
 1 file changed, 28 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index a413eb8..fa65b1d 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,34 @@
 # ESP32-WROVER-KIT-LCD-DRIVER
 
-LCD Driver for ST7789V/ILI9341 used ESP32-WROVER-KIT V4.1
+LCD Driver for ST7789V/ILI9341 used ESP32-WROVER-KIT
 
-## WIP
+## Overview
 
+In the ./main directory you can find following files:
 
-Using parts from:
-https://github.com/Everlers/demo_esp_lcd_st7789v
+_Example_Main.c_  Example for this project
+
+_LCD.c_           LCD Framebuffer Module  
+_LCD.h_           Header for importing in user application  
+
+_Driver.c_        SPI LCD Driver  
+_Driver.h_        Header SPI LCD Driver  
+
+## Code example
+
+``` c
+iLCD_init(); //init lcd screen
+
+iLCD_clearFramebuffer(COLOR_BLACK); //set complete screen to desired color
+
+iLCD_writeString(42,42,"Hello World!",COLOR_WHITE,COLOR_BLACK); //Write text to screen
+
+iLCD_writeString(42,50,"ESP32",COLOR_WHITE,COLOR_GREEN); //Write text to screen
+```
+## Documentation
+
+You can find the Doxygen HTML in ./Doxygen
+
+## Existing code used
+https://github.com/Everlers/demo_esp_lcd_st7789v  
 https://github.com/espressif/esp-idf/blob/master/examples/peripherals/spi_master/lcd