main: update documentation
This commit is contained in:
parent
d719fb7e02
commit
669e572c76
18
README.md
18
README.md
|
@ -2,26 +2,12 @@
|
||||||
|
|
||||||
<img src='https://github.com/coderofsalvation/xrshell/raw/main/src/assets/logo.svg' width="25%"/>
|
<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
|
# Usage
|
||||||
|
|
||||||
```html
|
```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">
|
<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
|
|
||||||
```
|
|
||||||
|
|
Loading…
Reference in New Issue