[docs] Describe the teleport event.

fernandojsg · Nov 2, 2017 · 82a2548 · 82a2548
1 parent 826c7be
commit 82a2548
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -94,3 +94,9 @@ Then register and use.
 ```js
 require('aframe-teleport-controls');
 ```
+
+### Events
+
+| Event      | Properties of `event.detail`             | Description                      |
+|------------|------------------------------------------|----------------------------------|
+| `teleport` | `oldPosition`, `newPosition`, `hitPoint` | Fires when teleportation begins. |