Docs improvements

This commit is contained in:
Jordan Eldredge 2025-06-22 20:32:36 -07:00
parent 6ad374934f
commit aa006df23e
9 changed files with 32 additions and 44 deletions

View file

@ -3,28 +3,16 @@
# Webamp
A reimplementation of Winamp 2.9 in HTML5 and JavaScript with full skin support.
A reimplementation of Winamp in HTML5 and JavaScript with full skin support.
As seen on [TechCrunch], [Motherboard], [Gizmodo], Hacker News ([1], [2], [3], [4]), and [elsewhere](./packages/webamp/docs/press.md).
[![Screenshot of Webamp](https://raw.githubusercontent.com/captbaritone/webamp/master/packages/webamp/demo/images/preview.png)](https://webamp.org)
Check out this [Twitter thread](https://twitter.com/captbaritone/status/961274714013319168) for an illustrated list of features. Works in modern versions of Edge, Firefox, Safari and Chrome. IE is [not supported](http://caniuse.com/#feat=audio-api).
## Add Webamp to Your Site
## Read the docs
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>
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).
**The [Webamp Documentation](https://docswebamp.org/docs) site contains detailed instructions showing how to add Webamp to your site and customize it to meet your needs.**
## About This Repository

View file

@ -0,0 +1,7 @@
# Skins
![Webamp skin musuem](../../static/img/winamp-skin-museum.png)
Webamp's most advanced feature is its ability to render any classic Winamp 2 skin in the browser. We have gone to great pains to ensure that Webamp renders skins pixel for pixel exactly how they were rendered in the Winamp 2.9. This has enabled Webamp to play a role in Winamp skin preservation by providing a way to keep classic Winamp skins [alive and accessible online](https://jordaneldredge.com/blog/winamp-skin-musuem/) even as the number of people with Winamp installed on their computers dwindles.
You can read more about how Webamp implements skin parsing and rendering in [this blog post](https://jordaneldredge.com/blog/how-winamp2-js-loads-native-skins-in-your-browser/).

View file

@ -0,0 +1,4 @@
{
"label": "Press",
"collapsible": true
}

View file

@ -1,11 +1,11 @@
# Winamp Skin Museum Press
This page lists various places where the [**Winamp Skin Musiem**](https://skins.webamp.org) project has been mentioned or discussed.
This page lists various places where the [**Winamp Skin Musiem**](https://skins.webamp.org) project has been mentioned or discussed.
For press mentions of the core Webamp proejct, see the [Webamp Press Page](./press.md).
# Skin Museum Press
For press mentions of the core Webamp project, see the [Webamp Press Page](./webamp-press.md).
## News Articles
- [The Verge](https://www.theverge.com/tldr/21430347/winamp-skin-museum-nostalgia-90s-00s-internet-art-history-ui)
- [Rock Paper Shotgun](https://www.rockpapershotgun.com/2020/10/08/the-winamp-skin-museum-really-whips-the-llamas-ass/)
- [GenBeta](https://www.genbeta.com/web/no-hay-mejor-mayor-homenaje-a-winamp-que-esta-web-65-000-skins/amp)
@ -19,15 +19,13 @@ For press mentions of the core Webamp proejct, see the [Webamp Press Page](./pre
- [Born in Space](https://www.borninspace.com/a-trip-down-memory-lane-the-winamp-skin-museum/)
- [TheStar](https://www.thestar.com.my/tech/tech-news/2020/11/21/winamp039s-historic-skins-get-their-own-online-museum)
## Aggregators
- Reddit
- [r/internetisbeautiful](https://www.reddit.com/r/InternetIsBeautiful/comments/ldjdxp/this_website_lets_you_use_winamp_in_your_browser/) (10.6k upvotes)
- [r/internetisbeautiful](https://www.reddit.com/r/InternetIsBeautiful/comments/ibumod/a_reimplementation_of_winamp_2_in_html5_and/) (9.0k upvotes)
- [r/internetisbeautiful](https://www.reddit.com/r/InternetIsBeautiful/comments/ilyjf1/infinite_scroll_through_65k_winamp_skins_with/) (4.7k upvotes)
- [r/tech](https://www.reddit.com/r/tech/comments/imv7bp/winamp_skin_museum_internet_history_around_2000/) (2.7k upvotes)
- [r/internetisbeautiful](https://www.reddit.com/r/InternetIsBeautiful/comments/ldjdxp/this_website_lets_you_use_winamp_in_your_browser/) (10.6k upvotes)
- [r/internetisbeautiful](https://www.reddit.com/r/InternetIsBeautiful/comments/ibumod/a_reimplementation_of_winamp_2_in_html5_and/) (9.0k upvotes)
- [r/internetisbeautiful](https://www.reddit.com/r/InternetIsBeautiful/comments/ilyjf1/infinite_scroll_through_65k_winamp_skins_with/) (4.7k upvotes)
- [r/tech](https://www.reddit.com/r/tech/comments/imv7bp/winamp_skin_museum_internet_history_around_2000/) (2.7k upvotes)
- [Hacker News](https://news.ycombinator.com/item?id=24373699) (690 points)
- [Imgur](https://imgur.com/gallery/wuq9BRv) (70k views)
- [Kottke.org](https://kottke.org/quick-links/2020-09)
@ -35,27 +33,34 @@ For press mentions of the core Webamp proejct, see the [Webamp Press Page](./pre
- [Product Hunt](https://www.producthunt.com/posts/winamp-skin-museum)
## German
- [Gamestar.de](https://www.gamestar.de/artikel/digitales-winamp-museum-65000-skins,3361648.html)
- [Golem.de](https://www.golem.de/sonstiges/zustimmung/auswahl.html?from=https%3A%2F%2Fwww.golem.de%2Fnews%2Fwinamp-skin-museum-musik-hoeren-wie-1999-2009-150820.html)
## Swedish
- [Feber](https://feber.se/internet/kolla-in-winamp-skin-museum/415425/)
## Spanish
- [Promo Descuentos](https://www.promodescuentos.com/ofertas/winamp-skin-museum-65000-skins-gratis-winap-502670)
- [La Nacion](https://www.lanacion.com.ar/tecnologia/winamp-museum-este-es-sitio-recopila-disenos-nid2446466)
- [Hipertextual](https://hipertextual.com/2020/12/winamp-online-winmap-skin-museum/)
- [Microsiervos](https://www.microsiervos.com/archivo/musica/winamp-skin-museum.html)
## Russian
- [Fishki](https://fishki.net/3416437-uterjannoe-iskusstvo-skinov-dlja-winamp.html)
- [Habr](https://habr.com/en/company/selectel/blog/530648/)
## Hebrew - עברית
- [GeekTime](https://www.geektime.co.il/winamp-skin-museum-with-over-65k-skins/)
## Turkish
- [Ekşi Şeyler](https://eksisozluk.com/entry/118824042)
## Polish
- [Joe Monster](https://joemonster.org/art/51463/Morele_jednak_nie_wywinie_sie_od_kary_Co_nowego_w_technologii_)
- [Joe Monster](https://joemonster.org/art/51463/Morele_jednak_nie_wywinie_sie_od_kary_Co_nowego_w_technologii_)

View file

@ -2,7 +2,7 @@
This page lists various places where the Webamp project has been mentioned or discussed.
For press mentions of the [Winamp Skin Museum](https://skins.webamp.org), see the [Winamp Skin Museum Press Page](./skin-museuem-press.md).
For press mentions of the [Winamp Skin Museum](https://skins.webamp.org), see the [Winamp Skin Museum Press Page](./skin-museum-press.md).
## Articles (notable)

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.9 MiB

View file

@ -6,12 +6,12 @@
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta
name="description"
content="Winamp 2.9 reimplemented in HTML5 and JavaScript"
content="Winamp reimplemented in HTML5 and JavaScript"
/>
<meta property="og:title" content="Webamp &bull; Winamp in your browser" />
<meta
property="og:description"
content="Winamp 2.9 reimplemented in HTML5 and JavaScript"
content="Winamp reimplemented in HTML5 and JavaScript"
/>
<meta property="og:type" content="website" />
<meta property="og:url" content="https://webamp.org" />

View file

@ -1,16 +0,0 @@
# Webamp Blog Posts
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/)
- [Implementing a Robust Web Audio API Balance Node](https://jordaneldredge.com/blog/implementing-a-robust-web-audio-api-balance-node/)
- [Making the case for building something useless](https://jordaneldredge.com/blog/making-the-case-for-building-something-useless/)
- [A Tour of Winamp2-js Features](https://jordaneldredge.com/blog/a-tour-of-winamp2-js-features/)
- [Crash Safari with the Web Audio API](https://jordaneldredge.com/blog/crash-safari-with-the-web-audio-api/)
- [How Winamp2-js loads native skins in your browser](https://jordaneldredge.com/blog/how-winamp2-js-loads-native-skins-in-your-browser/)
- [Surviving Hacker News traffic with the help of free CDNs](https://jordaneldredge.com/blog/surviving-hacker-news-traffic-with-the-help-of-free-cdns/)
- [I'm glad I factored out jQuery](https://jordaneldredge.com/blog/im-glad-i-factored-out-jquery/)