audioshowkit/README.md
2022-05-08 15:14:13 -05:00

18 lines
1013 B
Markdown

# 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://dev.sys.reslate.xyz/dev-auto/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.
## Documentation
[The documentation can be found here](https://dev.sys.reslate.xyz/dev-auto/job/AudioShowKit/job/master/AudioShowKit_20Docs/) along with the rest of the tutorials and demonstrations.