Merge pull request #6 from dbaldwin/hotfix/docs-for-0.1.4

init call necessary for v0.1.4+

README.md

@@ -1,2 +1,14 @@
 # go1-js
-Node JS Library for Unitree Go1
+
+## Node JS Library for Unitree Go1
+
+### Note: users upgrading to version 0.1.4 or newer you must initialize Go1 like the following:
+
+```
+let dog = new Go1();
+dog.init(); // version 0.1.4+ requirement
+dog.setMode(Go1Mode.walk);
+dog.goForward(0.25, 2000);
+```
+
+Take a look at the examples directory for more details.

examples/avoid-obstacle.ts

@@ -20,6 +20,7 @@ function handleCollisionDetection(state: Go1State): void {
 
 async function main() {
   dog = new Go1();
+  dog.init();
   dog.setLedColor(0, 255, 0);
 
   dog.on("go1StateChange", (state) => {

examples/dance.ts

@@ -4,6 +4,7 @@ let dog: Go1;
 
 async function main() {
   dog = new Go1();
+  dog.init();
 
   await dog.wait(3000);
 

examples/move-forward.ts

@@ -1,6 +1,7 @@
 import { Go1, Go1Mode } from "../src/go1";
 
 let dog = new Go1();
+dog.init();
 dog.setMode(Go1Mode.walk);
 dog.goForward(0.25, 2000);
 //dog.go(0, -0.25, -0.25, 1000);

examples/move-joints.ts

@@ -1,6 +1,7 @@
 import { Go1, Go1Mode } from "../src/go1";
 
 let dog = new Go1();
+dog.init();
 dog.setMode(Go1Mode.stand);
 
 async function run() {

examples/move-square.ts

@@ -2,6 +2,7 @@ import { Go1, Go1Mode } from "../src/go1";
 
 async function run() {
   let dog = new Go1();
+  dog.init();
   dog.setMode(Go1Mode.walk);
   await dog.goForward(0.1, 2000);
   await dog.goRight(0.1, 2000);