diff --git a/README.md b/README.md index f78a5a3380d546979a1f32bf043a18d63fff4ee8..28675874b6ac4cd08a19ad4b63f45b815967cb04 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