Mirrors/webamp
1
0
Fork 0
mirror of https://github.com/captbaritone/webamp.git synced 2026-01-23 02:15:01 +00:00
Code Issues Projects Releases Wiki Activity

Update docs to clarify that the base skin is included by default

Browse source
This commit is contained in:
Jordan Eldredge 2018-08-14 19:58:59 -07:00
parent 1b055b0b1f
commit 84e9b78e45
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/usage.md
View file

@ -55,9 +55,10 @@ const webamp = new Webamp({
// Can be downloaded from: https://github.com/captbaritone/webamp/raw/master/mp3/llama-2.91.mp3
url: "path/to/mp3/llama-2.91.mp3"
}],
// Optional. The default skin is included in the js bundle, and will be loaded by default.
initialSkin: {
// Can be downloaded from https://github.com/captbaritone/webamp/raw/master/skins/base-2.91.wsz
url: "path/to/skins/base-2.91.wsz"
// Can be downloaded from https://github.com/captbaritone/webamp/raw/master/skins/TopazAmp1-2.wsz
url: "path/to/skins/TopazAmp1-2.wsz"
},
});
// Render after the skin has loaded.
@ -115,7 +116,8 @@ The `Winamp` class is constructed with an options object.
```JavaScript
const options = {
// Required. An object representing the initial skin to use.
// Optional. An object representing the initial skin to use.
// If omitted, the default skin, included in the bundle, will be used.
// Note: This URL must be served the with correct CORs headers.
initialSkin: {
url: './path/to/skin.wsz'