updated docs + added MPL license

README.md

@@ -3,19 +3,25 @@
 
 [![Actions Status](https://github.com/coderofsalvation/xrfragment/workflows/test/badge.svg)](https://github.com/coderofsalvation/xrfragment/actions)
 
-# usage
+# Documentation 
+
+https://coderofsalvation.github.io/xrfragment
 
 # available implementations
 
-* [lua (handwritten)](dist/xrfragment.lua) [(+example)](src/xrfragment/Parser.lua)
 * [haXe](src/xrfragment)
-  * [javascript](dist/xrfragment.js) [(+example)](test/test.js)
-  * [python](dist/xrfragment.py) [(+example)](test/test.py)
-  * [lua](dist/xrfragment.lua) [(+example)](test/test.lua)
+* [javascript](dist/xrfragment.js) [(+example)](test/test.js)
+* [python](dist/xrfragment.py) [(+example)](test/test.py)
+* [lua](dist/xrfragment.lua) [(+example)](test/test.lua)
+
+See documentation for more info
 
 # development
 
+Pre-build libraries can be found in [/dist folder](dist)<br>
+If you really want to build from source:
+
 ```
 $ ./make install
-$ ./make && ./make runtest
+$ ./make build && ./make runtest
 ```

dist/license.js

@@ -0,0 +1,3 @@
+// SPDX-License-Identifier: MPL-2.0         
+// Copyright (c) 2023 Leon van Kammen/NLNET 
+

dist/xrfragment.aframe.js

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: MPL-2.0         *
+ * Copyright (c) 2023 Leon van Kammen/NLNET */
 var $hx_exports = typeof exports != "undefined" ? exports : typeof window != "undefined" ? window : typeof self != "undefined" ? self : this;
 (function ($global) { "use strict";
 $hx_exports["xrfragment"] = $hx_exports["xrfragment"] || {};

dist/xrfragment.module.js

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: MPL-2.0         *
+ * Copyright (c) 2023 Leon van Kammen/NLNET */
 var $hx_exports = typeof exports != "undefined" ? exports : typeof window != "undefined" ? window : typeof self != "undefined" ? self : this;
 (function ($global) { "use strict";
 $hx_exports["xrfragment"] = $hx_exports["xrfragment"] || {};

dist/xrfragment.three.js

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: MPL-2.0         *
+ * Copyright (c) 2023 Leon van Kammen/NLNET */
 var $hx_exports = typeof exports != "undefined" ? exports : typeof window != "undefined" ? window : typeof self != "undefined" ? self : this;
 (function ($global) { "use strict";
 $hx_exports["xrfragment"] = $hx_exports["xrfragment"] || {};

make

@@ -50,15 +50,17 @@ build(){
 
 build_js(){
   # add js module
-  cp dist/xrfragment.js dist/xrfragment.module.js
-  echo "export default xrfragment;" >> dist/xrfragment.module.js
+  cat dist/license.js dist/xrfragment.js > dist/xrfragment.module.js
+  echo "export default xrfragment;"     >> dist/xrfragment.module.js
   # add THREE module
-  cat dist/xrfragment.js     \
+  cat dist/license.js        \
+      dist/xrfragment.js     \
 			src/3rd/three/*.js     \
-			src/3rd/three/xrf/*.js > dist/xrfragment.three.js
+			src/3rd/three/xrf/*.js          > dist/xrfragment.three.js
   echo "export default xrfragment;"  >> dist/xrfragment.three.js
   # add AFRAME 
-  cat dist/xrfragment.js     \
+  cat dist/license.js        \
+      dist/xrfragment.js     \
 			src/3rd/three/*.js     \
 			src/3rd/three/xrf/*.js \
 			src/3rd/aframe/*.js    > dist/xrfragment.aframe.js

src/xrfragment/Parser.hx

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: MPL-2.0        
+// Copyright (c) 2023 Leon van Kammen/NLNET 
 package xrfragment;
 
 import xrfragment.XRF;

src/xrfragment/Parser.lua

@@ -1,3 +1,6 @@
+-- SPDX-License-Identifier: MPL-2.0         
+-- Copyright (c) 2023 Leon van Kammen/NLNET 
+
 XF = {}
 
 function split (inputstr, sep)

src/xrfragment/Query.hx

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: MPL-2.0        
+// Copyright (c) 2023 Leon van Kammen/NLNET 
 package xrfragment;
 
 //return untyped __js__("window.location.search");

src/xrfragment/URI.hx

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: MPL-2.0        
+// Copyright (c) 2023 Leon van Kammen/NLNET 
 package xrfragment;
 
 import xrfragment.Parser;

src/xrfragment/XRF.hx

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: MPL-2.0        
+// Copyright (c) 2023 Leon van Kammen/NLNET 
 package xrfragment;
 
 @:expose                                                                   // <- makes the class reachable from plain JavaScript

src/xrfragment/XRF.lua

@@ -1,3 +1,6 @@
+-- SPDX-License-Identifier: MPL-2.0        
+-- Copyright (c) 2023 Leon van Kammen/NLNET 
+
 local XRF = {}
 
 XRF.ASSET = 1