From 097d38b81f86bcbc806acc6a7b5c8e74f79f0126 Mon Sep 17 00:00:00 2001
From: Thomas Ballmann <mail@i-2xdream.de>
Date: Fri, 8 Jan 2021 19:48:09 +0100
Subject: [PATCH] #54 update readme

---
 README.md | 103 +++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 98 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index f9ab091..350e4c7 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,97 @@
-# paperdash-display
+hello world beispiel für neue face
 
-## build for deployment
-```properties
-pio run --environment lolin32
-platformio run --target buildfs
+***out of the box device***
+
+***usable for everyone and not only developer***
+
+
+
+# Introduction
+
+TODO, up to 3 images (2x device, 1x web app)
+
+## Features
+TODO ......
+
+### Firmware
+* OTA update
+* [REST API](https://app.swaggerhub.com/apis-docs/paperdash.io/paperdash-epd/0.1)
+* JPEG decoder (some limitations)
+* PNG decoder (work in progress)
+* Out-of-the-box slideshow with
+  * Current weather condition and forecast (https://openweathermap.org/ api key requried)
+  * Calendar view with random picture
+  * Today view with fullscreen random picture
+* Wifi STA fallback if connection failed
+
+### Web APP
+* ESP-32 optimized vue.js Web APP
+* [Material Design Framework](https://vuetifyjs.com/)
+* First run setup wizard
+* Screen preview of epd
+* Basic PWA possibility
+
+
+# Getting started
+
+## Necessary parts to build the project
+
+* ESP-32 microprocessor
+  * Amazon affiliate link [DE](https://amzn.to/34OYBol), US, UK, SP
+* TODO 640x384, 7.5inch E-Ink display. Black and white ONLY. (GDEW075T8 7.5" b/w)
+  * Amazon affiliate link [DE](https://amzn.to/34OYNnz)
+* 3D printed case
+
+## ESP-32 firmware
+
+> The whole architecture was inspired from the arduino concept with a setup() and loop() function.
+> This is the reason why everything is broken down into separate modules below `/lib`. Each module has basically a `setupXXX()` and `loopXXX()` method.
+
+### Build (with PlatformIO)
+```
+$ pio run --environment esp32
+
+// update esp
+$ platformio run --target upload
+```
+
+## Web APP
+
+> Based on state of the art technologie [Vue.js](https://vuejs.org/) + [Vuetify](https://vuetifyjs.com/) + [Webpack](https://webpack.js.org/)
+
+### Build
+```
+$ yarn --cwd app
+$ yarn --cwd app build
+$ platformio run --target buildfs
+
+// update esp
+$ platformio run --target upload
+```
+
+
+## API examples
+
+Post a image to display
 ```
+$ curl -F '=@demo.jpg;filename=dithering' http://paperdash-epd/api/device/screen
+```
+
+Access root filesystem
+
+http://paperdash-epd/fs/calendarPhoto.png
+
+
+
+## Similar projects
+
+> During my research, I have found exciting projects that are very similar to this one.
+- https://github.com/caedm/wall-ink
+- https://github.com/rgujju/paperdink
+- https://github.com/aceisace/Inkycal
+- https://github.com/ankesreich/eInkDisplayDriver
+
+------------------------------------------------
 
 
 ## compile and upload new firmware
@@ -22,6 +109,7 @@ platformio run --target uploadfs
 
 # send a picture to display over json
 curl -F '=@test3.png;filename=dithering' http://paperdash-epd/api/device/screen
+curl -F 'filename=@test1.jpg' http://paperdash-epd/api/device/screen
 
 # get current picture as bmp
 curl http://paperdash-epd/api/device/screen --output current.bmp
@@ -34,3 +122,8 @@ pio run --target erase
 
 > get photos from calendar face
 http://paperdash-epd/fs/calendarPhoto.png
+
+
+
+## swagger documentation
+https://app.swaggerhub.com/apis-docs/paperdash.io/paperdash-epd/0.1
\ No newline at end of file