aframe-keyboard-controls - npm Package Compare versions

Comparing version 0.1.2 to 0.1.3

package.json

 {
   "name": "aframe-keyboard-controls",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Keyboard controls for A-Frame.",
-  "main": "gamepad-controls.js",
+  "main": "keyboard-controls.js",
   "config": {
@@ -7,0 +7,0 @@ "demo_host": "localhost",

README.md

 # A-Frame `keyboard-controls` Component
 
-*(In Progress)* Keyboard controls for A-Frame.
+Keyboard controls for A-Frame.
 
 ## Overview
 
-Bindings and events for keyboard controls on an A-Frame VR scene. When combined with [proxy-controls](https://github.com/donmccurdy/aframe-proxy-controls), supports remote keyboard input from a host machine by WebRTC.
+Bindings and events for keyboard controls on an A-Frame VR scene. When combined with [ProxyControls.js](https://proxy-controls.donmccurdy.com) (with the [proxy-controls](https://github.com/donmccurdy/aframe-proxy-controls) component for A-Frame), can also receive remote keyboard input by WebRTC.
 
 ## Usage
 
-*Coming soon.*
+Movement + keyboard events:
+
+```html
+<a-scene>
+  <a-entity camera
+            keyboard-controls>
+  </a-entity>
+</a-scene>
+```
+
+Keyboard events only (no movement):
+
+```html
+<a-scene>
+  <a-entity camera
+            keyboard-controls="enabled: false">
+  </a-entity>
+</a-scene>
+```
+
+## Usage + Remote Device
+
+[ProxyControls.js ⇢ Docs](http://localhost:3000/#/docs#remote-device)
+
+Example:
+
+```html
+<a-scene proxy-controls>
+  <a-entity camera
+            keyboard-controls>
+  </a-entity>
+</a-scene>
+```

No alert changes

Improved metrics

Total package byte prevSize

144634

increased by0.38%

Number of lines in readme file

44

increased by266.67%

No dependency changes