Set up README and added gitignore

Rvthof · Oct 7, 2021 · f5022db · f5022db
1 parent 49aeaef
commit f5022db
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+node_modules
+dist
diff --git 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]