Update README.md

Author: fquirin

README.md

@@ -13,13 +13,69 @@ Available modules:
 - Custom SEPIA VAD module using Meyda to analyze bark-scale, **MFCC** and more
 - Wave Encoder with lookback-buffer
 - Porcupine Wake-Word detector (including: "Computer", "Jarvis", "Hey SEPIA" and more)
-- [SEPIA STT Server](https://github.com/SEPIA-Framework/sepia-stt-server) WebSocket module for speech recognition
+- [SEPIA STT Server](https://github.com/SEPIA-Framework/sepia-stt-server) WebSocket module for speech recognition (see STT Server for demo)
 - more to come ...
 
-## Tutorial
+## Quick-Start - Voice Recorder
 
-Full tutorial code can be found at: [tutorial-code-page.html](tutorial-code-page.html).  
-Please check out the modules and voice-recorder demo and test pages for more examples.  
+Efficiently resampling audio to 16000 Hz and creating 16Bit mono samples for speech recognition was one of the primary objectives when building this library.
+While you can put together your own audio pipeline to do that (see below) there is a very convenient plugin available that does the job for you.
+In this quick-start guide you will learn the basics to use the 'SepiaVoiceRecorder'.  
+  
+The first step is to import the required files and set the correct path to the modules folder. You will find more details about this step in the tutorial below. In this example the required files in 'modules' are 'speex-resample-switch.js', 'wave-encoder-worker.js' and 'shared/ring-buffer.min.js':
+```html
+<script type="text/javascript" src="test/sepia-web-audio.min.js"></script>
+<script type="text/javascript" src="test/sepia-recorder.min.js"></script>
+<script>
+	//set correct modules folder
+	SepiaFW.webAudio.defaultProcessorOptions.moduleFolder = "test/modules";
+</script>
+```
+
+Note that we chose to copy the minified core library, the recorder plugin and the modules folder to a folder named 'test'.  
+Now we can create our recorder:
+```javascript
+//catch some core events:
+SepiaVoiceRecorder.onProcessorReady = console.log; 	//add your own handler here
+SepiaVoiceRecorder.onProcessorInitError = console.error;
+
+//events to process data:
+SepiaVoiceRecorder.onResamplerData = function(data){
+	//here you can process raw data, e.g.:
+	//RMS volume: data.rms
+	//Raw 16Bit mono buffer: data.samples[0]
+}
+SepiaVoiceRecorder.onWaveEncoderAudioData = function(waveData){
+	//when we get encoded WAV data we can add it as audio element to our page:
+	SepiaVoiceRecorder.addAudioElementToPage(document.body, waveData, "audio/wav");
+}
+
+//create the recorder:
+SepiaVoiceRecorder.create({
+	targetSampleRate: 16000, 	//16kHz is actually the voice recorder default
+	gain: 3.0, 	//we can pre-amplify the signal using the gain option
+	recordingLimitMs: 30000, 	//Total recording limit ms
+});
+```
+
+Everything is prepared. To finally start recording you should wait for the ready event and then call:
+```javascript
+//to start:
+SepiaVoiceRecorder.start();
+
+//to stop:
+SepiaVoiceRecorder.stop();
+```
+
+That's it :-).  
+  
+Of cause there are many more events, options and features available ^^. Please check out the [voice-recorder-demo.html](voice-recorder-demo.html) for a more complex recorder setup including VAD etc..
+
+
+## Tutorial - Building Audio Pipelines
+
+Full code for this tutorial can be found at: [tutorial-code-page.html](tutorial-code-page.html).  
+Please check out the extensive [modules-demo.html](modules-demo.html) and the test pages for more examples.
 
 
 ### Part 1: Basic setup and single buffer module
@@ -32,7 +88,7 @@ Copy `sepia-web-audio.js` to your project and import the library using the `<hea
 <script type="text/javascript" src="src/sepia-web-audio.js"></script>
 ```
 
-Copy the audio modules you are planning to use and set the correct folder:
+Copy the audio modules you are planning to use, for part 1 of the tutorial we only need 'buffer-switch.js'. When you're done set the correct path to your modules folder:
 
 ```html
 <script>
@@ -41,7 +97,7 @@ Copy the audio modules you are planning to use and set the correct folder:
 ```
 
 Note: In this example we've used a folder called `src` for the library and modules folder but you can choose whatever you like.  
-Note2: Currently (v0.9.6) there is no Javascript modules support yet. Feel free to create a request via the issues section if you need it ;-).
+Note2: Currently there is no Javascript modules support yet. Feel free to create a request via the issues section if you need it ;-).
 
 #### Create the audio processor
 
@@ -103,7 +159,8 @@ If we don't want to restart later we can close the processor and clean up resour
 ### Part 2: Resample input and record raw 16Bit PCM mono audio (WAV)
 
 A very common use-case for this library is to resample microphone input and encode it as 16Bit PCM mono data (which is basically the default WAV file format).  
-To make this happen we will replace the buffer module from earlier with a resampler and wave encoder module.  
+To make this happen we will replace the buffer module from earlier with a resampler and wave encoder module. If you haven't done already please copy 'speex-resample-switch.js', 'wave-encoder-worker.js' and 'shared/ring-buffer.min.js' to your modules folder.  
+  
 NOTE: Some browsers are actually able to natively resampling for us ^^. The resampler module will simply skip transformation in this case but it might be preferable to prevent native resampling to retain full control over the quality and speed. 
 `SepiaFW.webAudio.isNativeStreamResamplingSupported` will be 'true' when the lib is imported because we can't test for the feature but set to 'false' after the first failed attempt of native resampling!