Skip to content

Commit ee6a5c0

Browse files
authored
Docs: update README.md
1 parent d3b8257 commit ee6a5c0

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,7 @@
22

33
[![npm](https://img.shields.io/npm/v/wavesurfer.js)](https://www.npmjs.com/package/wavesurfer.js)
44

5-
## New TypeScript version
6-
7-
wavesurfer.js v7 is a TypeScript rewrite of wavesurfer.js that brings several improvements:
8-
9-
* Typed API for better development experience
10-
* Enhanced decoding and rendering performance
11-
* New and improved plugins
5+
**Wavesurfer.js** is an interactive waveform rendering and audio playback library, perfect for web applications. It leverages modern web technologies to provide a robust and visually engaging audio experience.
126

137
<img width="626" alt="waveform screenshot" src="https://github.com/katspaugh/wavesurfer.js/assets/381895/05f03bed-800e-4fa1-b09a-82a39a1c62ce">
148

@@ -62,7 +56,7 @@ See the wavesurfer.js documentation on our website:
6256

6357
## Plugins
6458

65-
The "official" plugins have been completely rewritten and enhanced:
59+
We maintain a number of official plugins that add various extra features:
6660

6761
* [Regions](https://wavesurfer.xyz/examples/?regions.js) – visual overlays and markers for regions of audio
6862
* [Timeline](https://wavesurfer.xyz/examples/?timeline.js) – displays notches and time labels below the waveform
@@ -90,7 +84,17 @@ For example:
9084
You can see which elements you can style in the DOM inspector – they will have a `part` attribute.
9185
See [this example](https://wavesurfer.xyz/examples/?styling.js) to play around with styling.
9286

93-
## Upgrading from v6
87+
## v7 – a new TypeScript version
88+
89+
Wavesurfer.js v7 is a TypeScript rewrite of wavesurfer.js that brings several improvements:
90+
91+
* Typed API for better development experience
92+
* Enhanced decoding and rendering performance
93+
* New and improved plugins
94+
95+
<img width="749" alt="Screenshot 2023-12-06 at 09 06 30" src="https://github.com/katspaugh/wavesurfer.js/assets/381895/21eca2d9-47c7-461f-82bb-f23993818458">
96+
97+
### Upgrading from v6
9498

9599
Most options, events, and methods are similar to those in previous versions.
96100

0 commit comments

Comments
 (0)