From 1aa78d3c4a40645723546d54263a97ba61752d0a Mon Sep 17 00:00:00 2001 From: Andrei Date: Sat, 20 Apr 2019 15:35:13 +0300 Subject: [PATCH] Spelling --- README.md | 10 +++++----- package.json | 6 +++++- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 83278c2..08269d3 100644 --- a/README.md +++ b/README.md @@ -19,23 +19,23 @@ npm install @peermetrics/webrtc-stats ``` ## Usage -### Loding the module +### Loading the module WebRTC Stats can be loaded as an ES6 module, node module or directly in the browser. After loading the module, initialize it. -*See [Options](#options) for all the initalize options* +*See [Options](#options) for all the initialize options* ```js let stats = new WebRTCStats({ getStatsInterval: 5000 }) ``` -Add events listeners on the to listen to the `stats` event: +Add event listeners for `stats`: ```js stats.on('stats', (ev) => { console.log('stats', ev) }) ``` -Use the `stats` object to add peers to the list to monitor: +Use `addPeer` to add peers to the list of monitored peers: ```js let pc1 = new Peer({...}) stats.addPeer({ @@ -43,7 +43,7 @@ stats.addPeer({ peerId: '1' # any string/int that helps you identify this peer }) ``` -Now every `5000` ms WebRTC Stats will fire the `stats` event that will come with and object has the option +Now every `5000` ms WebRTC Stats will fire the `stats` event which will come with the object: ```js { event: 'stats', diff --git a/package.json b/package.json index 5f258a0..3b8eee4 100644 --- a/package.json +++ b/package.json @@ -8,7 +8,11 @@ "repository": "https://github.com/peermetrics/webrtc-stats", "author": "Andrei Onel ", "license": "MIT", - "keywords": [], + "keywords": [ + "webrtc", + "webrtc-stats", + "stats" + ], "scripts": { "build": "rollup -c && npm run copy", "serve": "npm run build && http-server dist",