From 5e0271fe5faf20fd38643e7dd19ed06025817e72 Mon Sep 17 00:00:00 2001
From: Tobias Hagemann <tobias.hagemann@skymatic.de>
Date: Tue, 9 Jan 2024 17:39:08 +0100
Subject: [PATCH] updated frontend README

[ci skip]
---
 frontend/README.md | 22 ++++++++++++++++++----
 1 file changed, 18 insertions(+), 4 deletions(-)

diff --git a/frontend/README.md b/frontend/README.md
index f5342b7d8..c85e4c59b 100644
--- a/frontend/README.md
+++ b/frontend/README.md
@@ -1,11 +1,25 @@
-# Vue 3 + Typescript + Vite
+# Cryptomator Frontend
 
-This template should help get you started developing with Vue 3 and Typescript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+This project uses Vue 3 + Typescript + Vite.
 
 ## Recommended IDE Setup
 
 - [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar)
 
-## Type Support For `.vue` Imports in TS
+## Dev Mode
 
-Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's `.vue` type support plugin by running `Volar: Switch TS Plugin on/off` from VSCode command palette.
+You can run your application in dev mode that enables live coding using:
+
+```shell script
+npm install
+npm run dev
+```
+
+## Production Build
+
+To build an optimized (production) version of the app, run:
+
+```shell script
+npm install
+npm run dist
+```