Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
disasteroftheuniverse committed Dec 31, 2019
1 parent 940d345 commit e7132a1
Showing 1 changed file with 21 additions and 19 deletions.
40 changes: 21 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,34 @@
# *_SuperQuest!_* Oculus Quest AFrame Components
# _SuperQuest!_ Oculus Quest AFrame Components

![image](https://www.repostatus.org/badges/latest/wip.svg) [![Documentation Status](https://readthedocs.org/projects/superquest/badge/?version=latest)](https://superquest.readthedocs.io/?badge=latest)

```md
__ ____ _
<pre> __ ____ _
/ _\_ _ _ __ ___ _ __ /___ \_ _ ___ ___| |_
\ \| | | | '_ \ / _ | '__// / | | | |/ _ / __| __|
_\ | |_| | |_) | __| | / \_/ /| |_| | __\__ | |_
\__/\__,_| .__/ \___|_| \___,_\ \__,_|\___|___/\__|
|_|
├── assets/
|
├── <b>assets</b>/
│ ├── hands.ma
│ └── hands.fbx
├── components/
│ ├── grab-controls.js
│ ├── hands.js
│ └── teleporter-controls.js
├── extras/
│ ├── extras.js
│ ├── google-poly.js
│ ├── portals.js
│ └── shaders.js
├── physics/
│ ├── physics.js
│ └── physics.worker.js
└── utils/
└── utils.js
├── <b>components</b>/
│ ├── aframe-extra-collection.js
│ ├── aframe-google-poly.js
│ ├── aframe-oculus-quest-hands.js
│ └── aframe-locomote-controls.js
└── <b>physics</b>/
├── physics-lite.js
└── physics-lite.worker.js
</pre>

## Installation

Include this script tag after your A-Frame script tag in the head of your document.

```html
<script src="https://cdn.jsdelivr.net/gh/disasteroftheuniverse/SuperQuest/dist/SuperQuest.full.min.js"></script>
```
## Examples

TODO: basically everything

0 comments on commit e7132a1

Please sign in to comment.