From 1f46465bbe51837899e9cb84340d16ab7199f74d Mon Sep 17 00:00:00 2001 From: Leon van Kammen Date: Tue, 16 Apr 2024 15:27:11 +0000 Subject: [PATCH] update documentation --- README.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index db4059a..311b37a 100644 --- a/README.md +++ b/README.md @@ -5,26 +5,31 @@ -# Documentation / Website +A tiny specification for viewing 3D models as linkable AR/VR websites.
+Address and Control anything inside a 3D model with [W3C Media Fragments](https://www.w3.org/TR/media-frags/) and [URI Templates](https://www.rfc-editor.org/rfc/rfc6570).
+
+ +![](https://coderofsalvation.github.io/xrfragment.media/images/metadata.jpg) + +
+Simply SURF a 3D file-verse and design for a Spatial Open Internet with the highest degree of interoperability ❤ + +# Documentation / Website https://xrfragment.org +![](https://coderofsalvation.github.io/xrfragment.media/images/nocode.jpg) + # Getting started -Here are various ways to enhance your 3D assets/scenes with XR Fragments: - -| | difficulty | how | notes | -|-|-|-|-| -| 1 | easiest | the xrfragment.org Sandbox | open 3D file (fbx/gltf) in Blender, add custom properties, and load exported files into the sandbox | -| 2 | easy | hosted sandbox by forking xrfragment-helloworld | Basically #1 but it will be hosted for free at your own github URL | -| 3 | developer | fork xfragment-aframe-helloworld | requires javascript- and aframe.io developer-knowledge | -| 4 | developer | fork xfragment-three-helloworld | requires javascript- and threejs developer-knowledge | -| 5 | developer++ | use a parser-library below | lowlevel approach, more suitable for other scenarios | +![](https://coderofsalvation.github.io/xrfragment.media/gettingstarted2024.mp4) +https://xrfragmenorg # available parser-implementations * [javascript](dist/xrfragment.js) [(+example)](test/test.js) +* [javascript module](dist/xrfragment.module.js) * [python](dist/xrfragment.py) [(+example)](test/test.py) * [lua](dist/xrfragment.lua) [(+example)](test/test.lua) * [haXe](src/xrfragment) (allows exporting to various programming languages)