From 0b85d9d71b1828ca872939de70e0b003740a39b4 Mon Sep 17 00:00:00 2001
From: katspaugh <381895+katspaugh@users.noreply.github.com>
Date: Tue, 28 Feb 2023 06:39:08 +0100
Subject: [PATCH 1/5] Docs: update the issue template and wavesurfer links
(#2671)
* Docs: update the issue template
* Update the readme
* katspaugh/wavesurfer.js -> wavesurfer-js/wavesurfer.js
---
.github/ISSUE_TEMPLATE.md | 23 ++++---
.github/workflows/publish.yml | 2 +-
README.md | 77 +++++++++---------------
assets/readme.txt | 2 +-
example/angular/index.html | 4 +-
example/annotation/index.html | 4 +-
example/audio-element/index.html | 4 +-
example/bars/index.html | 4 +-
example/cursor/index.html | 4 +-
example/elan-wave-segment/index.html | 4 +-
example/elan/index.html | 4 +-
example/equalizer/index.html | 4 +-
example/gradient-fill-styles/index.html | 4 +-
example/html-init/index.html | 4 +-
example/markers/index.html | 4 +-
example/media-session/index.html | 4 +-
example/mediaelement-webaudio/index.html | 4 +-
example/microphone/index.html | 4 +-
example/minimap-vertical/index.html | 4 +-
example/minimap/index.html | 4 +-
example/mute/index.html | 4 +-
example/panner/index.html | 4 +-
example/playhead/index.html | 4 +-
example/playlist/index.html | 4 +-
example/plugin-system/index.html | 4 +-
example/regions/index.html | 4 +-
example/rounded-bars/index.html | 4 +-
example/rtl/index.html | 4 +-
example/spectrogram/index.html | 4 +-
example/split-channels/index.html | 4 +-
example/split-wave-point-plot/index.html | 4 +-
example/stretcher/index.html | 4 +-
example/timeline-notches/index.html | 4 +-
example/timeline/index.html | 4 +-
example/vertical/index.html | 4 +-
example/video-element/index.html | 4 +-
example/zoom/index.html | 4 +-
package.json | 4 +-
38 files changed, 115 insertions(+), 125 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index 58391bf41..9a984ed64 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,17 +1,26 @@
-# Hey, thank you for testing and contributing to wavesurfer.js!
+# Hey, thank you for using and contributing to wavesurfer.js!
-## Please make sure you can check all of these points below before opening an issue:
+## Need help with wavesurfer.js in your app?
+
+Please start a Q&A dicussion in our forum: https://github.com/wavesurfer-js/wavesurfer.js/discussions/new?category=q-a
+
+## Have an idea for a feature?
+
+Consider sharing it in the forum: https://github.com/wavesurfer-js/wavesurfer.js/discussions/new?category=ideas
+
+## You think you found a bug?
+
+### Please make sure you can check all of these points below before opening an issue:
(You don't have to post this section)
- [ ] I have checked [the FAQ](https://wavesurfer-js.org/faq/) and it doesn't solve my problem.
- [ ] I have checked [the documentation](https://wavesurfer-js.org/docs/) and it doesn't solve my problem
-- [ ] I have searched for [already open issues](https://github.com/katspaugh/wavesurfer.js/issues) which desribe my problem.
-- [ ] The issue I'm having is related to and caused by wavesurfer.js, not by other software (which maybe packages and uses wavesurfer incorrectly) – In that case you should open the issue on the respective project pages.
+- [ ] I have searched for [already open issues](https://github.com/wavesurfer-js/wavesurfer.js/issues) which desribe my problem.
-## Please make sure you provide the following information (if applicable):
+## Please make sure to provide the following information (if applicable):
-### Wavesurfer.js version(s):
+### wavesurfer.js version(s):
### Browser and operating system version(s):
@@ -22,5 +31,5 @@
(Please reduce your code as much as possible and only post the minimum code needed to reproduce the issue. [A Code pen](http://codepen.io/) is an excellent way to share such code)
-### Use behaviour needed to reproduce the issue:
+### (Optional) Steps in the UI to reproduce the issue:
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
index 2f17abaee..c81c22b45 100644
--- a/.github/workflows/publish.yml
+++ b/.github/workflows/publish.yml
@@ -59,6 +59,6 @@ jobs:
-X POST \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token $GITHUB_TOKEN" \
- 'https://api.github.com/repos/katspaugh/wavesurfer.js/releases' \
+ 'https://api.github.com/repos/wavesurfer-js/wavesurfer.js/releases' \
-d "{\"tag_name\":\"$NEW_VERSION\", \"name\": \"$NEW_VERSION\"}"
fi
diff --git a/README.md b/README.md
index 1ba4ed850..5772e60eb 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,38 @@
# [wavesurfer.js](https://wavesurfer-js.org)
[](https://www.npmjs.com/package/wavesurfer.js)
- [](https://gitter.im/katspaugh/wavesurfer.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[](https://www.gitpoap.io/gh/katspaugh/wavesurfer.js)
+ [](https://gitter.im/wavesurfer-js/wavesurfer.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[](https://www.gitpoap.io/gh/wavesurfer-js/wavesurfer.js)
Interactive navigable audio visualization using Web Audio and Canvas.
-[](https://wavesurfer-js.org)
+[](https://wavesurfer-js.org)
See a [tutorial](https://wavesurfer-js.org/docs) and [examples](https://wavesurfer-js.org/examples) on [wavesurfer-js.org](https://wavesurfer-js.org).
-## Browser support
-wavesurfer.js works only in [modern browsers supporting Web Audio](http://caniuse.com/audio-api).
+## Questions
+Have a question about integrating wavesurfer.js on your website? Feel free to ask in our forum: https://github.com/wavesurfer-js/wavesurfer.js/discussions/categories/q-a
-It will fallback to Audio Element without graphics in other browsers (IE 11 and lower).
+## Quick start
-## FAQ
-### Can the audio start playing before the waveform is drawn?
-Yes, if you use the `backend: 'MediaElement'` option. See here: https://wavesurfer-js.org/example/audio-element/. The audio will start playing as you press play. A thin line will be displayed until the whole audio file is downloaded and decoded to draw the waveform.
+```
+npm install wavesurfer.js --save
+
+# or
+
+yarn add wavesurfer.js
-### Can drawing be done as file loads?
-No. Web Audio needs the whole file to decode it in the browser. You can however load pre-decoded waveform data to draw the waveform immediately. See here: https://wavesurfer-js.org/example/audio-element/ (the "Pre-recoded Peaks" section).
+# or
-## API in examples
+
+```
-Choose a container:
+Create a container in your HTML:
```html
```
-Create an instance, passing the container selector and [options](https://wavesurfer-js.org/docs/options.html):
+
+Create an instance of wavesufer.js, passing the container selector and a few [options](https://wavesurfer-js.org/docs/options.html):
```javascript
var wavesurfer = WaveSurfer.create({
@@ -56,43 +60,20 @@ wavesurfer.load('example/media/demo.wav');
See the documentation on all available [methods](https://wavesurfer-js.org/docs/methods.html), [options](https://wavesurfer-js.org/docs/options.html) and [events](https://wavesurfer-js.org/docs/events.html) on the [homepage](https://wavesurfer-js.org/docs/).
-## Upgrade
-
-See the [upgrade](https://github.com/katspaugh/wavesurfer.js/blob/master/UPGRADE.md) document if you're upgrading from a previous version of wavesurfer.js.
-
-## Using with a module bundler
-
-Install Wavesurfer:
-```bash
-npm install wavesurfer.js --save
-# or
-yarn add wavesurfer.js
-```
-
-Use it with a module system like this:
-```javascript
-// import
-import WaveSurfer from 'wavesurfer.js';
+## Pojects using wavesurfer.js
-// commonjs/requirejs
-var WaveSurfer = require('wavesurfer.js');
-
-// amd
-define(['WaveSurfer'], function(WaveSurfer) {
- // ... code
-});
-
-```
+For the list of projects using wavesurfer.js, check out
+[the projects page](https://wavesurfer-js.org/projects/).
-## Related projects
+## Contributing
-For a list of projects using wavesurfer.js, check out
-[the projects page](https://wavesurfer-js.org/projects/).
+Have an idea and want to contribute to wavesurfer.js?
+Please first start a discussion in the [Ideas section of our forum](https://github.com/wavesurfer-js/wavesurfer.js/discussions/categories/ideas) to coordinate with the maintainers.
-## Development
+### Development
-[](https://github.com/katspaugh/wavesurfer.js/actions?workflow=wavesurfer.js)
-[](https://coveralls.io/github/katspaugh/wavesurfer.js)
+[](https://github.com/wavesurfer-js/wavesurfer.js/actions?workflow=wavesurfer.js)
+[](https://coveralls.io/github/wavesurfer-js/wavesurfer.js)
Install development dependencies:
@@ -134,7 +115,7 @@ npm run doc
If you want to use [the VS Code - Debugger for Chrome](https://github.com/Microsoft/vscode-chrome-debug), there is already a [launch.json](.vscode/launch.json) with a properly configured ``sourceMapPathOverrides`` for you.
## Editing documentation
-The homepage and documentation files are maintained in the [`gh-pages` branch](https://github.com/katspaugh/wavesurfer.js/tree/gh-pages). Contributions to the documentation are especially welcome.
+The homepage and documentation files are maintained in the [`gh-pages` branch](https://github.com/wavesurfer-js/wavesurfer.js/tree/gh-pages). Contributions to the documentation are especially welcome.
## Updating the NPM package
When preparing a new release, update the version in the `package.json` and have it merged to master. The new version of the package will be published to NPM automatically via GitHub Actions.
@@ -143,7 +124,7 @@ When preparing a new release, update the version in the `package.json` and have
The main maintainer: [Thijs Triemstra](https://github.com/thijstriemstra)
-Many thanks to [all the awesome contributors](https://github.com/katspaugh/wavesurfer.js/contributors)!
+Many thanks to [all the awesome contributors](https://github.com/wavesurfer-js/wavesurfer.js/contributors)!
## License
diff --git a/assets/readme.txt b/assets/readme.txt
index d23eb1031..f7db3a2c8 100644
--- a/assets/readme.txt
+++ b/assets/readme.txt
@@ -1,5 +1,5 @@
Logo is free to use with this project, link back to the official github page to support the project.
-https://github.com/katspaugh/wavesurfer.js
+https://github.com/wavesurfer-js/wavesurfer.js
Available Logo Versions:
- svg text logo (black/white)
diff --git a/example/angular/index.html b/example/angular/index.html
index dd066d325..7dccf0c09 100644
--- a/example/angular/index.html
+++ b/example/angular/index.html
@@ -88,7 +88,7 @@
[Thijs Triemstra](https://github.com/thijstriemstra)
-Many thanks to [all the awesome contributors](https://github.com/katspaugh/wavesurfer.js/contributors)!
+Many thanks to [all the awesome contributors](https://github.com/wavesurfer-js/wavesurfer.js/contributors)!
## License
diff --git a/assets/readme.txt b/assets/readme.txt
index d23eb1031..f7db3a2c8 100644
--- a/assets/readme.txt
+++ b/assets/readme.txt
@@ -1,5 +1,5 @@
Logo is free to use with this project, link back to the official github page to support the project.
-https://github.com/katspaugh/wavesurfer.js
+https://github.com/wavesurfer-js/wavesurfer.js
Available Logo Versions:
- svg text logo (black/white)
diff --git a/example/angular/index.html b/example/angular/index.html
index dd066d325..7dccf0c09 100644
--- a/example/angular/index.html
+++ b/example/angular/index.html
@@ -88,7 +88,7 @@