xrsh
/
xrsh-com
1
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects Releases Wiki Activity

main: update documentation
/ mirror_to_github (push) Successful in 15s Details
/ test (push) Successful in 4s Details

This commit is contained in:
Leon van Kammen 2024-05-30 14:53:01 +00:00
parent d719fb7e02
commit 669e572c76
1 changed files with 2 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -2,26 +2,12 @@
<img src='https://github.com/coderofsalvation/xrshell/raw/main/src/assets/logo.svg' width="25%"/>
This is a library of useful AFRAME components which can be used in any AFRAME app, but also are exposed as 'apps' in [xrshell](https://github.com/coderofsalvation/xrshell):
This is a library of useful AFRAME components which can be used in any AFRAME app, which are higher-level than usual (and used in [XRSH](https://coderofsalvation.github.io/xrsh):
# Usage
```html
<script src="https://coderofsalvation.github.io/xrshell-apps/helloworld.js"/>
<script src="https://coderofsalvation.github.io/xrsh/src/com/example/helloworld.js"/>
<a-entity helloworld="foo:1" class="cubes" name="box">
```
In [xrshell](https://github.com/coderofsalvation/xrshell) these components can be applied to entities using controllers/gestures, or via a xrshell terminal:
```bash
$ open foo.gltf
scene/box
scene/pyramid
$ component helloworld
> enter value for foo: 1
$ export --html > scene.html
$ export --gltf > scene.gltf
```