diff --git a/README.md b/README.md index cc45000..ef956f1 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,11 @@ In addition, the Hubs themselves have certain built-in features which this libra * Plugging two Boost Tacho Motors into the Powered UP Hub will crash the Hub (This requires a firmware update from LEGO to fix). -### Usage +### Documentation + +[Full documentation is available here.](https://nathankellenicki.github.io/node-poweredup/) + +### Sample Usage ```javascript const PoweredUP = require("node-poweredup"); diff --git a/docs/BoostMoveHub.html b/docs/BoostMoveHub.html index abcc649..81f503e 100644 --- a/docs/BoostMoveHub.html +++ b/docs/BoostMoveHub.html @@ -5134,7 +5134,7 @@ This is a helper method to make it easier to wait for concurrent commands to com
diff --git a/docs/DuploTrainBase.html b/docs/DuploTrainBase.html index 9eee670..5161644 100644 --- a/docs/DuploTrainBase.html +++ b/docs/DuploTrainBase.html @@ -3809,7 +3809,7 @@ This is a helper method to make it easier to wait for concurrent commands to com
diff --git a/docs/Hub.html b/docs/Hub.html index c243e7c..b5715e1 100644 --- a/docs/Hub.html +++ b/docs/Hub.html @@ -2169,7 +2169,7 @@ This is a helper method to make it easier to wait for concurrent commands to com
diff --git a/docs/LPF2Hub.html b/docs/LPF2Hub.html index bff558e..c58ec21 100644 --- a/docs/LPF2Hub.html +++ b/docs/LPF2Hub.html @@ -4133,7 +4133,7 @@ This is a helper method to make it easier to wait for concurrent commands to com
diff --git a/docs/PUPHub.html b/docs/PUPHub.html index 452be80..021feff 100644 --- a/docs/PUPHub.html +++ b/docs/PUPHub.html @@ -4721,7 +4721,7 @@ This is a helper method to make it easier to wait for concurrent commands to com
diff --git a/docs/PUPRemote.html b/docs/PUPRemote.html index 28b4698..f61390f 100644 --- a/docs/PUPRemote.html +++ b/docs/PUPRemote.html @@ -3058,7 +3058,7 @@ This is a helper method to make it easier to wait for concurrent commands to com
diff --git a/docs/PoweredUP.html b/docs/PoweredUP.html index e40ccad..0479f45 100644 --- a/docs/PoweredUP.html +++ b/docs/PoweredUP.html @@ -753,7 +753,7 @@
diff --git a/docs/WeDo2SmartHub.html b/docs/WeDo2SmartHub.html index 21fd70b..829614e 100644 --- a/docs/WeDo2SmartHub.html +++ b/docs/WeDo2SmartHub.html @@ -4603,7 +4603,7 @@ This is a helper method to make it easier to wait for concurrent commands to com
diff --git a/docs/boostmovehub.js.html b/docs/boostmovehub.js.html index a28a7b3..6cccb31 100644 --- a/docs/boostmovehub.js.html +++ b/docs/boostmovehub.js.html @@ -262,7 +262,7 @@ exports.BoostMoveHub = BoostMoveHub;
diff --git a/docs/consts.js.html b/docs/consts.js.html index c3b01bb..4bfdaaa 100644 --- a/docs/consts.js.html +++ b/docs/consts.js.html @@ -190,7 +190,7 @@ var BLECharacteristic;
diff --git a/docs/duplotrainbase.js.html b/docs/duplotrainbase.js.html index 4110cef..2a6116a 100644 --- a/docs/duplotrainbase.js.html +++ b/docs/duplotrainbase.js.html @@ -211,7 +211,7 @@ exports.DuploTrainBase = DuploTrainBase;
diff --git a/docs/global.html b/docs/global.html index 1918166..430cacb 100644 --- a/docs/global.html +++ b/docs/global.html @@ -3014,7 +3014,7 @@
diff --git a/docs/hub.js.html b/docs/hub.js.html index 0362500..73eb194 100644 --- a/docs/hub.js.html +++ b/docs/hub.js.html @@ -377,7 +377,7 @@ exports.Hub = Hub;
diff --git a/docs/index.html b/docs/index.html index 68609c8..eb4377b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -191,7 +191,8 @@
  • Plugging two Boost Tacho Motors into the Powered UP Hub will crash the Hub (This requires a firmware update from LEGO to fix).

  • -

    Usage

    const PoweredUP = require("node-poweredup");
    +

    Documentation

    Full documentation is available here.

    +

    Sample Usage

    const PoweredUP = require("node-poweredup");
     const poweredUP = new PoweredUP.PoweredUP();
     
     poweredUP.on("discover", async (hub) => { // Wait to discover a Hub
    @@ -225,7 +226,7 @@ poweredUP.scan(); // Start scanning for Hubs

    More examples are av

    - Documentation generated by JSDoc 3.5.5 on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.5.5 on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
    diff --git a/docs/lpf2hub.js.html b/docs/lpf2hub.js.html index d365a80..1446421 100644 --- a/docs/lpf2hub.js.html +++ b/docs/lpf2hub.js.html @@ -422,7 +422,7 @@ exports.LPF2Hub = LPF2Hub;
    - Documentation generated by JSDoc 3.5.5 on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.5.5 on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
    diff --git a/docs/poweredup.js.html b/docs/poweredup.js.html index 3f10fb9..d4fa640 100644 --- a/docs/poweredup.js.html +++ b/docs/poweredup.js.html @@ -186,7 +186,7 @@ exports.PoweredUP = PoweredUP;
    - Documentation generated by JSDoc 3.5.5 on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.5.5 on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
    diff --git a/docs/puphub.js.html b/docs/puphub.js.html index 306a506..555a5d9 100644 --- a/docs/puphub.js.html +++ b/docs/puphub.js.html @@ -219,7 +219,7 @@ exports.PUPHub = PUPHub;
    - Documentation generated by JSDoc 3.5.5 on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.5.5 on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
    diff --git a/docs/pupremote.js.html b/docs/pupremote.js.html index bf6d2e5..f526d54 100644 --- a/docs/pupremote.js.html +++ b/docs/pupremote.js.html @@ -149,7 +149,7 @@ exports.PUPRemote = PUPRemote;
    - Documentation generated by JSDoc 3.5.5 on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.5.5 on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
    diff --git a/docs/wedo2smarthub.js.html b/docs/wedo2smarthub.js.html index b86d895..1b7f0a9 100644 --- a/docs/wedo2smarthub.js.html +++ b/docs/wedo2smarthub.js.html @@ -377,7 +377,7 @@ exports.WeDo2SmartHub = WeDo2SmartHub;
    - Documentation generated by JSDoc 3.5.5 on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.5.5 on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)