diff options
| author | Feross Aboukhadijeh <feross@feross.org> | 2016-03-23 05:56:59 +0300 |
|---|---|---|
| committer | Feross Aboukhadijeh <feross@feross.org> | 2016-03-24 07:32:28 +0300 |
| commit | 095fdbcd12c79253dbe23701f31ca901889525f0 (patch) | |
| tree | 765dacb6a7e7dda3244b8753e85e7d9f44f9d31e /docs/api.md | |
| parent | 3fcaa39966760c33853ae05884a7272a6763bb7a (diff) | |
docs: minor torrent.addPeer() tweak
Diffstat (limited to 'docs/api.md')
| -rw-r--r-- | docs/api.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/api.md b/docs/api.md index 49f2b1e..f10dcc5 100644 --- a/docs/api.md +++ b/docs/api.md @@ -201,7 +201,10 @@ Alias for `client.remove(torrent)`. ## `torrent.addPeer(peer)` -Adds a peer to the underlying [bittorrent-swarm](https://github.com/feross/bittorrent-swarm) instance. +Adds a peer to the underlying +[bittorrent-swarm](https://github.com/feross/bittorrent-swarm) instance. Normally, you +don't need to call `torrent.addPeer()`. WebTorrent will automatically find peers using the +tracker servers or DHT. This is just for manually adding a peer to the client. Returns `true` if peer was added, `false` if peer was blocked by the loaded blocklist. |