From cd3eb101d3e0f758a080a13b8ab395a0c2201f66 Mon Sep 17 00:00:00 2001
From: Benny <66417262+ThisIsBenny@users.noreply.github.com>
Date: Sat, 29 Jan 2022 11:18:46 +0100
Subject: [PATCH] Update README.md

---
 README.md | 29 ++++++++++++++---------------
 1 file changed, 14 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 7ff86fb..a07b72a 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,26 @@
 # wishlist
 
-This template should help get you started developing with Vue 3 in Vite.
+The wish list webapp is a simple webapp for publishing wish lists. It allows to share wishlists for different people or occasions with friends and family. If something was bought from the wishlist, it can be removed from the list to prevent duplicate purchases.
 
-## Recommended IDE Setup
+The app can be easily self-hosted via Docker (see docker-compose example below).
 
-[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin).
 
-## Type Support for `.vue` Imports in TS
+## Docker Setup
 
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
+```yaml
+version: '3.7'
 
-If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
+services:
+  wishlist:
+    image: thisisbenny/wishlist-webapp:latest
+    ports:
+      - '5000:5000'
+    volumes:
+      - ./data:/app/data
+```
 
-1. Disable the built-in TypeScript Extension
-    1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
-    2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
-2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
 
-## Customize configuration
-
-See [Vite Configuration Reference](https://vitejs.dev/config/).
-
-## Project Setup
+## Development Setup
 
 ```sh
 npm install