diff options
| -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. |