Alpha release

README.md

@@ -1,2 +1,39 @@
-# table-order
+# table-order (Alpha)
+
+# Description
 Table ordering with a QR code allows customers to scan a code at their table, access a digital menu, and place their order directly from their smartphone, streamlining the ordering process totaly writen in Python.
+
+Keep in mind there are currently bugs and also missing features all listed below please don't use in production jet!
+# How to set it up
+---
+## Sites
+currently there are 4 Sites
+
+/login -> to Login 
+/logout -> just browse to this URL ending to logout for now
+/orders -> All open orders (Not automatically refreshign on new order)
+/order -> Where users can place there order.
+to change what you can order take a look at the example in /json/availiable-products.json
+
+## Settings
+All settings are in /Options.ini
+Default has to be changed to your needs:
+
+host -> is where the QR code points to whit secret if enabled.
+max_desks -> How many desk it shoud create.
+Execute in Terminal the "pip install -r required.txt" to download depending and "python app.py" to run the Flask server and whit it the webserver.
+
+## 
+
+Note:
+This are early stages of this project listed are missing and planed.
+# To Does
+---
+Must have features / fixes
+TODO's in prio sortet
+1. #TODO on new orderGet refresh orders list
+2. #BUG Fixing
+3. #Feature STOCK management
+4. #TODO Settings and init menu or buttons
+5. #Polish Make the HTML prettier for all
+6. #Polish LOG exacter