From cb1846d22df6ba6e503f1a970b2595a53bab2c1e Mon Sep 17 00:00:00 2001 From: Leon van Kammen Date: Fri, 31 Mar 2023 19:21:31 +0200 Subject: [PATCH] update documentation --- README.md | 4 ++-- doc/RFC.md | 8 +++++--- make | 2 ++ 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e860edd..29b366f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ - - + + [![Actions Status](https://github.com/coderofsalvation/xrfragment/workflows/test/badge.svg)](https://github.com/coderofsalvation/xrfragment/actions) diff --git a/doc/RFC.md b/doc/RFC.md index 05fb332..08fb6dd 100644 --- a/doc/RFC.md +++ b/doc/RFC.md @@ -14,13 +14,14 @@ # XR Fragments (key/value params) -> ⛁ = supported in 3D asset-file (custom property or projection)
-> ⚂ = supported in navigator URI (`document.location.href` e.g.)
+> ⛁ = define in 3D asset-file (as custom property or default projection)
+> ☇ = mutable, using navigator URI (`document.location.href` e.g.)
| param | type | scope(s) | category | notes | |---------|---------------|-------|--------------------|---------------------------------| | prio | int (-10..1) | ⛁ | Asset loading / linking | \#static allow client to ignore lower-prio objects in the renderloop, to compensate frame-drop/cpu/gpu-overload scenario’soc/notes/prio.md | -| pos | 3D vector | ⛁ ⚂ |HREF navigation/portals | | +| pos | 3D vector | ⛁ ☇ |HREF navigation/portals | | +| q | string | ⛁ |Query Selector | | # XR Fragments parser @@ -56,6 +57,7 @@ the gist of it: 1. integers are detected using regex `/^[0-9]+$/` 1. floats are detected using regex `/^[0-9]+\.[0-9]+$/` 1. vectors are detected using regex `/[,]/` (but can also be an string referring to an entity-ID in the asset) +1. anything else is string `/.*/` # Tests diff --git a/make b/make index b0cf39b..4698aef 100755 --- a/make +++ b/make @@ -33,6 +33,8 @@ tests(){ doc(){ { + echo '' + echo '' echo "> version $VERSION" echo "\ndate: $(date +"%Y-%m-%dT%H:%M:%S%z") (generated by \`./make doc\`)\n" echo "[![Actions Status](https://github.com/coderofsalvation/xrfragment/workflows/test/badge.svg)](https://github.com/coderofsalvation/xrfragment/actions)\n"