diff options
| author | Feross Aboukhadijeh <feross@feross.org> | 2016-03-17 00:14:18 +0300 |
|---|---|---|
| committer | Feross Aboukhadijeh <feross@feross.org> | 2016-03-17 00:14:18 +0300 |
| commit | 4c0b6586dc88a67c4049de9ec7bdeb8c1fee6975 (patch) | |
| tree | 36eea789da8708d8156cecae112bd550accda59a /docs | |
| parent | 772d881e82f20a0eafb6bac8ad4e51f1f5a2b8ae (diff) | |
docs: add note about webrtc to quick-start.md
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/quick-start.md | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/quick-start.md b/docs/quick-start.md index d1bbfc4..b0969e7 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -1,5 +1,9 @@ -WebTorrent works in the **browser** and **node.js**, and provides the same API in -both environments. +WebTorrent is a streaming torrent client for **Node.js** and the **web**. WebTorrent +provides the same API in both environments. + +To use WebTorrent in the browser, [WebRTC] support is required (Chrome, Firefox, Opera). + +[webrtc]: https://en.wikipedia.org/wiki/WebRTC ## Install |