From f5022db83371e034e355edf9abc202254e504240 Mon Sep 17 00:00:00 2001 From: Robert van 't Hof Date: Thu, 7 Oct 2021 11:12:28 +0100 Subject: [PATCH] Set up README and added gitignore --- .gitignore | 2 ++ README.md | 13 ++++++------- 2 files changed, 8 insertions(+), 7 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..76add87 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +node_modules +dist \ No newline at end of file diff --git a/README.md b/README.md index cbeea4d..cb4658a 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,13 @@ ## UnityWrapperWidget -[My widget description] - -## Features -[feature highlights] +This widget let's you set up the files to load a Unity file in a Mendix app using WebGL. +It uses https://github.com/jeffreylanters/react-unity-webgl for this. ## Usage -[step by step instructions] +The widget needs to load 4 specific files that come with a Unity file. +For this, it needs four filedocument public URL's to the files. -## Demo project -[link to sandbox] +In order to get a FileDocument's URL, use the GetGUID call from the Community Commons which is available on the Mendix Marketplace. +You can then construct the URL like this: '/file?guid='+$GUID ## Issues, suggestions and feature requests [link to GitHub issues]