fix lint command + up dependencies + clean up

Author: chrisweb

README.md

@@ -10,6 +10,12 @@ Visualizes waveform data (peaks), for example the ones that got generated using:
 
 Waveform created using data that got generated using the [waveform data generator](https://github.com/chrisweb/waveform-data-generator)
 
+## installation
+
+if you want to use the waveform visualizer in your own project you can install it from npm using the following command:
+
+`npm i waveform-visualizer`
+
 ## examples
 
 Check out the [simple waveform example](/examples/simple-waveform/README.md)
@@ -52,7 +58,7 @@ to lint the typescript files
 
 ## changelog
 
-3.0.0 removed UMD support, this and future versions will be ESM only
+3.0.0 updated dependencies and removed UMD support, this and future versions will be ESM only
 
 ## contributing (help / PRs appreciated 😊)
 

dist/index.umd.js

@@ -1,7 +1,97 @@
-# waveform-visualizer examples
+# waveform-visualizer - simple waveform-visualizer example
 
-## getting started
+## build
 
-### installing
+first, use your favorite command line tool and go into the root of this project:
 
-* 
+```shell
+cd /waveform-visualizer
+```
+
+then use the follwing command in the root of this repository to build the waveform-visualizer itself:  
+
+`npm run build`
+
+Note: for more instructions about the waveform-visualizer itself check out the [waveform-visualizer README](../../README.md)  
+
+then, build the example (server & client) itself:  
+
+go into the example folder:  
+
+```shell
+cd /waveform-visualizer/examples/simple-waveform
+```
+
+install the latest nodejs (if you haven't already) [nodejs](https://nodejs.org)  
+
+update npm to latest version  
+
+`npm install npm@latest -g`
+
+install the server dependencies  
+
+### client
+
+#### go into the client folder
+
+```shell
+cd client
+```
+
+#### install the client dependencies
+
+```shell
+npm i
+```
+
+### build the client
+
+```shell
+npm run build
+```
+
+### server
+
+#### go into the server folder
+
+```shell
+cd server
+```
+
+#### install the server dependencies
+
+```shell
+npm i
+```
+
+#### build the server
+
+```shell
+npm run build
+```
+
+#### start the server
+
+start the server
+
+`npm run start`
+
+## usage
+
+open the project in your browser:  
+
+`http://127.0.0.1:35000/`
+
+* click the play button to launch the song
+* the stop button (you guessed it) stops the song from playing
+* click into the waveform to change the song position
+* you can adjust the volume using the volume bar at the bottom
+
+check out the /client source code, especially /client/library/visualizer.ts to get an idea of how you can use the visualizer in your own projects  
+
+* the audio player I used for the demo, is another of my projects and is available on npm too: https://www.npmjs.com/package/web-audio-api-player
+* the waveform data for the song was generated using another of my projects, the "waveform data generator" and the source code to build create your own data can be found on github: https://github.com/chrisweb/waveform-data-generator
+
+## linting
+
+the linting is now done via the npm run lint command of the main project