diff options
| author | Aditya Shankar <me@adityashankar.xyz> | 2020-05-05 17:18:19 +0300 |
|---|---|---|
| committer | Aditya Shankar <me@adityashankar.xyz> | 2020-05-05 17:18:19 +0300 |
| commit | 88a99dc8921967372182e0407e88c1a73eb6c374 (patch) | |
| tree | 27b7a430161ef56d48eae326988e47a19d735f67 /docs/api.md | |
| parent | fb8392d9f3a60fd0d5727a1d71967c06186844da (diff) | |
added more explicit docs for certian key items (relevent github issue https://github.com/webtorrent/webtorrent/issues/1846)
Diffstat (limited to 'docs/api.md')
| -rw-r--r-- | docs/api.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md index 062343b..e178c18 100644 --- a/docs/api.md +++ b/docs/api.md @@ -109,6 +109,8 @@ If you provide `opts.store`, it will be called as * `storeOpts.files` - an array of torrent file objects * `storeOpts.torrent` - the torrent instance being stored +**Note:** downloading a torrent automatically seeds it, allowing the user to also serve the file to others who need it + ## `client.seed(input, [opts], [function onseed (torrent) {}])` Start seeding a new torrent. |