audioshowkit/README.md

# AudioShowKit

A library that makes visualizing audio data live a much simpler process.

## Getting Started

As this library has not been published as a package, the best way to use it is to go to download the latest successful build artifact which can be [found here](https://sys.reslate.net/rho/ci/job/projects-reslate/job/audioshowkit/job/master/). This build artifact is a minified and bundled version of all the components in the library.

From here, add the downloaded javascript bundle to your html as you would any other javascript file:
```
<script src="./audioshowkit.js" defer></script>
```

Now, any script that is loaded after the `audioshowkit.js` script loads will have access to the `audioshowkit` object. Prepared are three tutorials with demonstrations. I recommend starting with the Music Playlist tutorial.

## Resources

The documentation along with latest stable build [can be found here](https://sys.reslate.net/rho/ci/job/projects-reslate/job/audioshowkit/job/master/). The documentation is accessible to on the left bar and the build artifact can be downloaded as a zip.