Update README code example to use correct element ID

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

Update README code example to use correct element ID #369

Closed OmarShehata closed 3 years ago

OmarShehata commented 3 years ago

I copied the code snippet from the README while setting up PeakJS and was confused why I was getting an error. Turns out there are two code examples that incorrectly reference the HTML element IDs as overview-waveform and zoomview-waveform but they are set up in the very first example as X-container instead of X-waveform.

This PR updates these two examples to reference overview-container and zoomview-container to be consistent with all the other examples.

chrisn commented 3 years ago

Sorry that the documentation was misleading, and thank you for fixing it for us!

OmarShehata commented 3 years ago

Thank you for the quick response and for maintaining this awesome library and making it freely available!