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 | |
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')
-rw-r--r-- | docs/api.md | 2 | ||||
-rw-r--r-- | docs/get-started.md | 21 |
2 files changed, 23 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. diff --git a/docs/get-started.md b/docs/get-started.md index 362e8fe..db3511c 100644 --- a/docs/get-started.md +++ b/docs/get-started.md @@ -63,6 +63,8 @@ Video and audio content can be streamed, i.e. playback will start before the ful file is downloaded. Seeking works too – WebTorrent dynamically fetches the needed torrent pieces from the network on-demand. +**Note:** downloading a torrent automatically seeds it, allowing the user to also serve the file to other peers + ### Creating a new torrent and seed it (in the browser) ```js @@ -102,6 +104,25 @@ client.add(magnetURI, { path: '/path/to/folder' }, function (torrent) { }) ``` +### Creating a new torrent and seed it (in Node.js) + +**Note:** Seeding a torrent to be compatible with the browser (i.e. with support for WebRTC) requires [webtorrent-hybrid](https://github.com/webtorrent/webtorrent-hybrid) (note this requires Node version 12, 13 to work, Node v14 will NOT work with this module, lower node versions may also be supported) + +```js +var WebTorrent = require('webtorrent-hybrid') +var client = new WebTorrent() + +client.seed(__dirname + "/seedy.txt", function (torrent) { + console.log('Client is seeding ' + torrent.magnetURI) +}) +``` + +where **seedy.txt** is a text file which is going to be seeded as a torrent, such as + +``` +hi there, I'm gonna be seeded as a torrent ! +``` + ### Complete HTML page example Looking for a more complete example? Look no further! This HTML example has a form input |