From 56d886a4378dc4e7c986c2b7e8ccc99272c83d18 Mon Sep 17 00:00:00 2001
From: Remy Raes <raes.remy@gmail.com>
Date: Mon, 3 Oct 2022 18:22:17 +0200
Subject: docs: update readme

---
 src-vue/README.md | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

(limited to 'src-vue/README.md')

diff --git a/src-vue/README.md b/src-vue/README.md
index 30b15e21..e6d7ea6e 100644
--- a/src-vue/README.md
+++ b/src-vue/README.md
@@ -1,16 +1,18 @@
-# Vue 3 + TypeScript + Vite
+# FlightCore UI
 
-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 folder holds FlightCore's interface repository.
 
-## Recommended IDE Setup
+This is a [Vue (v4)](https://vuejs.org/) project, using [Element Plus](https://element-plus.org/en-US/) component library.
 
-- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
+## Development
 
-## Type Support For `.vue` Imports in TS
+```shell
+# Install dependencies
+npm install
 
-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 Take Over mode by following these steps:
+# Run in development mode
+npm run dev
 
-1. Run `Extensions: Show Built-in Extensions` from VS Code's command palette, look for `TypeScript and JavaScript Language Features`, then right click and select `Disable (Workspace)`. By default, Take Over mode will enable itself if the default TypeScript extension is disabled.
-2. Reload the VS Code window by running `Developer: Reload Window` from the command palette.
-
-You can learn more about Take Over mode [here](https://github.com/johnsoncodehk/volar/discussions/471).
+# Build for production
+npm run build
+```
-- 
cgit v1.2.3