Update README.md

Author: desher

README.md

@@ -1,21 +1,41 @@
 # webrtc-issue-detector
-WebRTC diagnostic tool that detects issues with network or user devices
 
-----
+Diagnostic tool for WebRTC applications that analyzes WebRTC getStats() result in realtime and generates a report on possible issues.
+
+
+## Key features
+
+- **Mean opinion score** - calculates [MOS](https://en.wikipedia.org/wiki/Mean_opinion_score) for inbound and outbound network connections that can indicate problems before it even appears.
+- **CPU issues** - indicates possible issues with encoding and decoding media streams.
+- **Server issues** - indicates possible server side issues.
+- **Fully customizable** - allows to create your own detectors or WebRTC getStats() parsers.
+
 
 ## Installation
 `yarn add webrtc-issue-detector`
 
 
 ## Usage
-### Import
+
+### Getting started
 ```typescript
 import WebRTCIssueDetector from 'webrtc-issue-detector';
 
-return new WebRTCIssueDetector({
-    onIssues: (issues) => console.log('Issues detected:', issues),
-    onNetworkScoresUpdated: (scores) => console.log('Network scores updated:', scores),
+// create it before the first instance of RTCPeerConnection is created
+const webRtcIssueDetector = new WebRTCIssueDetector({
+    onIssues: (issues) => issues.map((issue) => {
+        console.log('Issues type:', issue.type); // eg. "network"
+        console.log('Issues reason:', issue.reason); // eg. "outbound-network-throughput"
+        console.log('Issues reason:', issue.debug); // eg. "packetLoss: 12%, jitter: 230, rtt: 150"
+    }),
+    onNetworkScoresUpdated: (scores) => {
+        console.log('Inbound network score', scores.inbound); // eg. 3.7
+        console.log('Outbound network score', scores.outbound); // eg. 4.5
+    }
 });
+
+// start collecting getStats() and detecting issues
+webRtcIssueDetector.watchNewPeerConnections();
 ```
 
 ### Configure
@@ -61,6 +81,118 @@ new WebRTCIssueDetector({
 });
 ```
 
+## Detectors
+
+### AvailableOutgoingBitrateIssueDetector
+Detects issues with outgoing network connection.
+```js
+{
+    type: 'network',
+    reason: 'outbound-network-throughput',
+    debug: '...'
+}
+```
+
+### FramesDroppedIssueDetector
+Detects issues with decoder.
+```js
+{
+    type: 'cpu',
+    reason: 'decoder-cpu-throttling',
+    debug: '...'
+}
+```
+
+### FramesEncodedSentIssueDetector
+Detects issues with outbound network throughput.
+```js
+{
+    type: 'network',
+    reason: 'outbound-network-throughput',
+    debug: '...'
+}
+```
+
+### InboundNetworkIssueDetector
+Detects issues with inbound network connection.
+```js
+{
+    type: 'network',
+    reason: 'inbound-network-quality' | 'inbound-network-media-latency' | 'network-media-sync-failure',
+    iceCandidate: 'ice-candidate-id'
+    debug: '...'
+}
+```
+
+Also can detect server side issues if there is high RTT and jitter is ok.
+```js
+{
+    type: 'server',
+    reason: 'server-issue',
+    iceCandidate: 'ice-candidate-id'
+    debug: '...'
+}
+```
+
+### NetworkMediaSyncIssueDetector
+Detects issues with audio syncronization.
+```js
+{
+    type: 'network',
+    reason: 'network-media-sync-failure',
+    ssrc: '...'
+    debug: '...'
+}
+```
+
+### OutboundNetworkIssueDetector
+Detects issues with outbound network connection.
+```js
+{
+    type: 'network',
+    reason: 'outbound-network-quality' | 'outbound-network-media-latency',
+    iceCandidate: 'ice-candidate-id'
+    debug: '...'
+}
+```
+
+### QualityLimitationsIssueDetector
+Detects issues with encoder and outbound network. Based on native qualitiLimitationReason.
+```js
+{
+    type: 'cpu',
+    reason: 'encoder-cpu-throttling',
+    ssrc: '...'
+    debug: '...'
+}
+```
+
+```js
+{
+    type: 'network',
+    reason: 'outbound-network-throughput',
+    ssrc: '...'
+    debug: '...'
+}
+```
+
+### VideoCodecMismatchDetector
+Detects issues with decoding stream.
+```js
+{
+    type: 'stream',
+    reason: 'codec-mismatch',
+    ssrc: '...',
+    trackIdentifier: '...',
+    debug: '...'
+}
+```
+
+## Roadmap
+
+- [ ] Adaptive getStats() call interval based on last getStats() exectution time 
+- [ ] Structured issue debug
+- [ ] Issues detector for user devices permissions
 
 ## Test
 `yarn test`