add documentation!

[mmckegg]

This is a pretty cool module. TELL THE WORLD ABOUT IT!

[naugtur]

I found it on npm and I'd gladly find out what it can do without reading the code :)

[zya]

still don't get what this library is supposed to do. Although it seems like it should be doing something cool.
Documentation would really help me understand.

[mmckegg]

Haha, yeah. 😽

It is pretty much single handedly powering the audio engine in Loop Drop.

The reason I haven't written any docs is because it's a bit of a mess and needs to be split out into multiple modules. Also I kept changing the API every few weeks.

It allows you to declaratively describe a Web Audio API node setup using JSON, then push in a new state and then only update the AudioParams that have changed. Basically react for Web Audio.

[zya]

maybe a little example in the readme to keep people starting?
Like how you would make a simple oscillator -> gain -> destination example.

[yoshuawuyts]

Yeah, having at least a bit of an example would be much appreciated! (':

[mmckegg]

Gonna start documenting all this stuff next Tuesday.

Promise! 😊 👻

[yoshuawuyts]

😻

[mmckegg]

Added a simple example to the readme. Also see https://github.com/mmckegg/audio-slot-param which has been extracted out of this module.