diff --git a/readme.md b/readme.md index 52528c1..e88d506 100644 --- a/readme.md +++ b/readme.md @@ -2,6 +2,10 @@ DMX-512 controller library for node.js - also includes a Webinterface and HTTP API. +## Install + + npm install -g dmx + ## Webinterface ### Configuration @@ -138,13 +142,21 @@ The options Object takes an easing key which allows to set a easing - outBounce - inOutBounce +Returns a Animation object with the animation step added. + + #### animation.delay(duration) - duration - Number, duration in ms Delay the next animation step for duration. +Returns a Animation object with the delay step added. + #### animation.run(universe, onFinish) - universe - Object, reference to the universe driver - onFinish - Function, called when the animation is done + +Run the Animation on the specified universe. +