bbc / peaks.js

JavaScript UI component for interacting with audio waveforms
https://waveform.prototyping.bbc.co.uk
GNU Lesser General Public License v3.0
3.2k stars 279 forks source link

[docu] unpgk link broken #416

Closed rowild closed 2 years ago

rowild commented 2 years ago

The docu links to this CDN: https://unpkg.com/peaks.js/dist/peaks.js

But unpgk complains: Cannot find "/dist/peaks.js" in peaks.js@0.26.0

Without the /dist the "normal" peaks can be found: https://unpkg.com/peaks.js@0.26.0/peaks.js

but that one is not minimized.

(I think the dist folder has to be published, too, for unpgk...?)

Also, if peaks.js is included via script tag, what about Konva and waveform-data? Do they have to be included via script tag, too, or does peaks.js take care of that in this case?

chrisn commented 2 years ago

The docs refer to the latest code on the master branch, which differs to what's published via npm and unpkg. I've been working on updating the build to use Rollup to replace browserify, so there's a lot of change. The next release will indeed have a /dist folder, when it's ready to publish.

For now, the right docs to use are at https://github.com/bbc/peaks.js/tree/v0.26.0. Sorry for causing the confusion.

rowild commented 2 years ago

It is confusing that there is a v1 tag... :-) Sorry for my stupid messages which I now deleted.

chrisn commented 2 years ago

Yes, that's an old and unmaintained branch. I'm hoping to release 0.27 soon, which has a good number of changes. My only concern is whether I've got the Rollup packaging right.

rowild commented 2 years ago

@chrisn Happy to test! :-)

chrisn commented 2 years ago

I think the way to test would be to clone the repository, then do npm install and npm run build, then use npm link to include it into your own project.

rowild commented 2 years ago

@chrisn Just a short feedback after some days using your rollup version: Haven't tested everything yet, but so far everything works very smooth. :-) Thank you!

chrisn commented 2 years ago

Thank you. I have just published v0.27.0 to npm.