diff options
author | Feross Aboukhadijeh <feross@feross.org> | 2016-03-17 02:54:16 +0300 |
---|---|---|
committer | Feross Aboukhadijeh <feross@feross.org> | 2016-03-17 02:54:16 +0300 |
commit | 18f985a645d1ab808efaf81abd458e93a86049d3 (patch) | |
tree | 98f697cfca1ffbcc1be55ee4c349ec3b45293a33 | |
parent | 1339332582844b251ae479445438e89c599d5ba5 (diff) |
readme
-rw-r--r-- | README.md | 8 | ||||
-rw-r--r-- | docs/api.md | 2 |
2 files changed, 5 insertions, 5 deletions
@@ -206,7 +206,7 @@ to browserify. However, webpack requires the following extra configuration: ``` Otherwise you could also directly use the pre-built version via `require('webtorrent/webtorrent.min')`. -#### Global +##### Script tag WebTorrent is also available as a standalone script ([`webtorrent.min.js`](webtorrent.min.js)) which exposes `WebTorrent` on the `window` @@ -223,7 +223,7 @@ MaxCDN) for easy inclusion on your site: <script src="https://cdn.jsdelivr.net/webtorrent/latest/webtorrent.min.js"></script> ``` -#### In node.js +#### In Node.js WebTorrent also works in node.js, using the *same npm package!* It's mad science! @@ -233,8 +233,8 @@ support for node. #### As a command line app -WebTorrent is available as [a command line app](https://github.com/feross/webtorrent-cli). -Here's how to use it: +WebTorrent is also available as a +[command line app](https://github.com/feross/webtorrent-cli). Here's how to use it: ```bash $ npm install webtorrent-cli -g diff --git a/docs/api.md b/docs/api.md index 4192af3..fbf450a 100644 --- a/docs/api.md +++ b/docs/api.md @@ -26,7 +26,7 @@ If `opts` is specified, then the default options (shown below) will be overridde peerId: String|Buffer, // Wire protocol peer ID (default=randomly generated) rtcConfig: Object, // RTCPeerConnection configuration object (default=STUN only) tracker: Boolean, // Whether or not to enable trackers (default=true) - wrtc: Object // Custom webrtc implementation (in node, specify the [wrtc](https://www.npmjs.com/package/wrtc) package) + wrtc: Object // Custom webrtc implementation (in node, specify the [wrtc](https://www.npmjs.com/package/wrtc) or [electron-webrtc](https://github.com/mappum/electron-webrtc) package) } ``` |