From 2e3ca2f71a5dd1882563c91a56d4aabdd97bd1ce Mon Sep 17 00:00:00 2001
From: Matthias Betz <matthias.betz@hft-stuttgart.de>
Date: Thu, 21 Nov 2024 13:26:11 +0100
Subject: [PATCH] update description

---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f78a5a3..2867587 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,10 @@
-# SmartVillages2
+# SmartVillages2 VCMap Plugin
+
+This plugin enables to place glTF/glb models in VCMap. It can also hide existing buildings to make space for a new object.
+
+It works without connecting to other servers, the inserted models stay on the local computer and are not transferred over the internet.
+The plugin also has an interface to a converter service which can convert IFC files to glb models. This will require the IFC file to be sent
+to the service. It will be temporarily stored on the server and will be deleted on the server after the conversion process is completed.
 
 
 ## Plugin Configuration
@@ -18,4 +24,18 @@ The instructions property can be a link to a pdf or html or anything else.
       "instructions": "<Link to a instructions document>"
     }
   ],
+```
+
+## Building / Packaging
+
+The plugin can be built with:
+
+```
+npx plugin build
+```
+
+To package for uploading in VCPublisher
+
+```
+npx plugin pack
 ```
\ No newline at end of file
-- 
GitLab