From 688315441e564c188f2be6dc30c4ea022735602f Mon Sep 17 00:00:00 2001
From: FUH22860 <101731147+FUH22860@users.noreply.github.com>
Date: Fri, 23 Jun 2023 14:32:57 +0200
Subject: [PATCH] Add content to README.md (#38)

* Add content to README.md

* Add project description

* Update README.md
---
 README.md | 46 +++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 45 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 09a1eb2..3b7afb1 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,47 @@
 # y4f
 
-[![Deploy blazor to GitHub Pages](https://github.com/yummy4friends/y4f/actions/workflows/main.yml/badge.svg?branch=dev)](https://github.com/yummy4friends/y4f/actions/workflows/main.yml)
+## Description (German)
+
+Yummy4Friends ist eine benutzerfreundliche und visuell ansprechende Webapp zur Onlinebestellung von Speisen mit der dynamischen Einbindung einer Kunden- und Speisendatenbank unter Berücksichtigung von Sonderwünschen. Zur Kundenbindung wird auch die Verwaltung von Kundenrabatten, Vorbestellmöglichkeiten sowie konfigurierbare Abholtermine realisiert.
+
+## Description (English)
+
+Yummy4Friends is a user friendly and visually appealing WebApp for ordering food or other things online. Food or other stuff get dynamically fetched from a customer and food database while also taking into account special requests. To attract customers one can also offer limeted time sales/coupons, ordering in advance as well as being able to choosing their preferred pickup time.  
+
+## Tech Stack
+
+[Blazor WebAssembly](https://dotnet.microsoft.com/en-us/apps/aspnet/web-apps/blazor)
+
+## Dependecies
+
+On Ubuntu our dependencies are:
+
+```bash
+nala install dotnet-sdk-7.0 docker-ce docker-ce-cli docker-buildx-plugin docker-compose-plugin
+```
+
+Dependency names will depend on your linux distribution.
+
+For this this project you also need Traefik. Or you can use your own reverse proxy and edit the docker-compose files to reflect that. 
+
+## Running it
+
+Clone the repo.
+
+```bash
+git clone https://github.com/yummy4friends/y4f.git && cd y4f
+```
+
+Start the website with docker-compose.
+
+```bash
+docker-compose up --build -d
+```
+
+Also start up the API.
+
+```bash
+cd src/WebApi/ && docker-compose up --build -d
+```
+
+This setup is for showcasing the project and is therefore not intended for production.