From 01e7d7c4955ace2803a4338c7300b0ce746608f5 Mon Sep 17 00:00:00 2001
From: Ace <saadnaseer63@yahoo.de>
Date: Fri, 29 May 2020 23:14:19 +0200
Subject: [PATCH] Update README.md

---
 README.md | 27 +++++++++++++++++++++++----
 1 file changed, 23 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 67e387f..29e0f40 100644
--- a/README.md
+++ b/README.md
@@ -49,19 +49,38 @@ pip3 install -e ./
 ```
 
 ### Creating settings file
-...TODO
+Please visit the [Online WEB-UI](http://aceinnolab.com/web-ui-v2-0-0-beta.html) to create your settings.json file.
+You can alternatively also open `settings-UI.html` in your web-browser.
+
+* Fill in the details and click on `generate` to create your settings.json file
+* Copy the settings.json file to your raspberry pi
+* Copy the path (location) of this file
 
 ### Running Inkycal
-```bash
+```python3
 # Open Python3 and import package
 from inkycal import Inkycal
-ink = Inkycal()
+
+# tell the Inkycal class where your settings file is
+ink = Inkycal('/path/to/your/settings/file', render = True)
+# render means rendering (showing) on the ePaper. Setting render = False will not show anything on the ePaper
+
+# test if Inkycal can be run correctly, running this will show a bit of info for each module
+ink.test()
+
+# If there were no issues, you can run Inkycal nonstop:
+ink.run()
 ```
 
+## Known issues (will be fixed before production)
+* [ ] Inkycal-image is not yet supported
+* [ ] Inkycal-server is not yet supported -> depends on inkycal-image
+* [ ] Calibration is not yet implemented automatically. For now, only manual calibration is supported: `ink.calibrate()`
 
-# Please ignore anything after this, work in progress from here on----------------------------
 
 
+# Please ignore anything after this, work in progress from here on------------
+
 ## Main features
 * Monthly Calendar that shows events from your Google (or other) iCalendar/s
 * Live weather info and forecasts for next 9 hours (openweathermap)