Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: add ToC #3969

Merged
merged 1 commit into from
Dec 25, 2024
Merged

Docs: add ToC #3969

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,18 @@

**Gold sponsor 💖** [Closed Caption Creator](https://www.closedcaptioncreator.com)

# Table of contents

1. [Getting started](#getting-started)
2. [API reference](#api-reference)
3. [Plugins](#plugins)
4. [CSS styling](#css-styling)
5. [Frequent questions](#questions)
6. [Upgrading from v6 to v7](#upgrading-from-v6-to-v7)
7. [Development](#development)
8. [Tests](#tests)
9. [Feedback](#feedback)

## Getting started

Install and import the package:
Expand Down Expand Up @@ -120,16 +132,14 @@ However, please keep in mind that this forum is dedicated to wavesurfer-specific
Generally, wavesurfer.js doesn't aim to be a wrapper for all things Web Audio. It's just a player with a waveform visualization. It does allow connecting itself to a Web Audio graph by exporting its audio element (see <a href="https://wavesurfer.xyz/examples/?4436ec40a2ab943243755e659ae32196">this example</a>) but nothign more than that. Please don't expect wavesurfer to be able to cut, add effects, or process your audio in any way.
</details>

## v7 – a new TypeScript version
## Upgrading from v6 to v7

Wavesurfer.js v7 is a TypeScript rewrite of wavesurfer.js that brings several improvements:

* Typed API for better development experience
* Enhanced decoding and rendering performance
* New and improved plugins

### Upgrading from v6

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

### Notable differences
Expand Down
Loading