Documentation cleanup, including making the example less clever

This commit is contained in:
Jordan Eldredge 2021-07-31 13:50:09 -07:00
parent 067bb16c9d
commit 1d3e404142
3 changed files with 25 additions and 1 deletions

View file

@ -18,7 +18,11 @@ Here is the **most minimal** example of adding Webamp to a page:
```HTML
<div id="app"></div>
<script src="https://unpkg.com/webamp"></script>
<script>new Webamp().renderWhenReady(app);</script>
<script>
const app = document.getElementById("app")
const webamp = new Webamp();
webamp.renderWhenReady(app);
</script>
```
For more examples, including how to add audio files, check out [`examples/` directory](./examples) and the [API documentation](./packages/webamp/docs/usage.md).
@ -34,6 +38,7 @@ Webamp uses a [monorepo](https://en.wikipedia.org/wiki/Monorepo) approach, so in
* [`packages/winamp-eqf`](https://github.com/captbaritone/webamp/tree/master/packages/winamp-eqf): An NPM module for parsing and constructing Winamp equalizer preset files (`.eqf`)
* [`packages/archive-org-webamp-integration-tests`](https://github.com/captbaritone/webamp/tree/master/packages/archive-org-webamp-integration-tests): An integration that confirms that archive.org's Webamp integration is working as expected
* [`packages/webamp-modern`](https://github.com/captbaritone/webamp/tree/master/packages/webamp-modern): A prototype exploring rendering "modern" Winamp skins in the browser
* [`packages/webamp-modern-2`](https://github.com/captbaritone/webamp/tree/master/packages/webamp-modern-2): A second attempt at exploring rendering "modern" Winamp skins in the browser
* [`examples`](https://github.com/captbaritone/webamp/tree/master/examples): A few examples showing how to use the NPM module
## Community

View file

@ -35,6 +35,23 @@ To update snapshots run
yarn test -u
## Cutting a Release
1. Update the version number in `package.json`
2. Rename the "Next" title at the top of `CHANGELOG.md` to the new version number and ensure it is up to date
3. Update the static `VERSION` property of the `Webamp` class in `webamplazy.tsx`
4. Git commit
5. `npm publish`
6. Git tag the commit (e.g. `1.4.2` or `1.4.3-beta.3`)
6. Push tag to GitHub `git push origin <TAG_NAME>`
7. Update all the examples to use the new version:
* `minimal/index.html`
* `minimalMilkdrop/index.html`
* `webpack/package.json`
* `webpackLazyLoad/package.json`
* https://codesandbox.io/s/y0xypox60z
8. Commit and push
## Reference
- [skinspecs.pdf](http://members.xoom.it/skinart/tutorial/skinspecs..pdf)

View file

@ -2,6 +2,8 @@
Over the years that I've been working on Webamp, I've written a number of blog posts on topics related to it.
- [Building the @WinampSkins Twitter Bot](https://jordaneldredge.com/blog/building-the-winampskins-twitter-bot/)
- [Using Machine Learning to Generate Winamp Skins](https://jordaneldredge.com/blog/using-machine-learning-to-generate-winamp-skins/)
- [Speeding Up Webamp's Music Visualizer with WebAssembly](https://jordaneldredge.com/blog/speeding-up-winamps-music-visualizer-with-webassembly/)
- [Rendering Animated .ani Cursors in the Browser](https://jordaneldredge.com/blog/rendering-animated-ani-cursors-in-the-browser/)
- [Mainlining Nostalgia: Making the Winamp Skin Museum](https://jordaneldredge.com/blog/winamp-skin-musuem/)