xrf.js/README.md

20 lines
700 B
Markdown

XR Fragment utilities
=====================
These are helper functions to make 3D (javascript) viewers XR Fragment compatible.
See function list below
> this README.md is generated by running `echo "$(./README.awk *.js)" > README.md`
# library functions
import {...} from 'xrf/level0'
| function | example |
|------------------------|-------------------------------------------------------------------------|
| sideCarFiles(...) | sideCarFiles("https://f.org/a.glb") `// ["https://f.org/a.png",...]` |
| fetchSideCarFiles(...) | await fetchSideCarFiles("https://f.org/a.glb") `// [{code:200},...]` |