From 25a587b61490c6bde82f684edef3d860292049ab Mon Sep 17 00:00:00 2001
From: km0 <luzzanafrancesco@gmail.com>
Date: Sat, 12 Aug 2023 16:23:39 +0200
Subject: [PATCH] updated readme

---
 README.md | 21 +++++++++++++++++----
 1 file changed, 17 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 480dd98..7927391 100644
--- a/README.md
+++ b/README.md
@@ -11,12 +11,25 @@ Developed with Vite and Vue.
 The idea is: a minimal surface to sketch storyboard uploading images and sorting them through drag and drop.
 Ideally at the end a `csv` or `pdf` could be exported. 
 
+## Features
 
+- Multiple scenes
+- Load files with drag and drop
+- Support both video and images
+- Prevent accidental navigation
+- Import / Export projects
+- Data never leave your machine
+- No server, no database, nothing
+- Organize clips by color
 
-## Vue 3 + Vite
+## To build
 
-This template should help get you started developing with Vue 3 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.
+To build a static version from the vite project this is the command:
+
+```yarn vite build --outDir /var/www/html/sb --base /soupboat/sb --emptyOutDir```
+
+- `--outDir` set the output directory, in this case the public folder clumsy-mapping, that will be served from NGINX
+- `--base` set the base url with the /soupboat/ prefix
+- `--emptyOutDir` empty the output directory before building the project
 
-## Recommended IDE Setup
 
-- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).