Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/webtorrent/webtorrent.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFeross Aboukhadijeh <feross@feross.org>2020-10-27 22:42:11 +0300
committerFeross Aboukhadijeh <feross@feross.org>2020-10-27 22:42:11 +0300
commit40b3ca2ef1bed2b3fa707f4bcb4086175254dc74 (patch)
tree8030442279668bc0ed0b42a6a850907e1cf0415e /docs
parent4600674c17d13607957a3f269b10e2af01d6d19d (diff)
docs
Diffstat (limited to 'docs')
-rw-r--r--docs/api.md2
-rw-r--r--docs/get-started.md12
2 files changed, 5 insertions, 9 deletions
diff --git a/docs/api.md b/docs/api.md
index 87bd5d3..e965764 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -110,7 +110,7 @@ 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
+**Note:** Downloading a torrent automatically seeds it, making it available for download by other peers.
## `client.seed(input, [opts], [function onseed (torrent) {}])`
diff --git a/docs/get-started.md b/docs/get-started.md
index 4f0872a..169997d 100644
--- a/docs/get-started.md
+++ b/docs/get-started.md
@@ -63,7 +63,7 @@ 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
+**Note:** Downloading a torrent automatically seeds it, making it available for download by other peers.
### Creating a new torrent and seed it (in the browser)
@@ -106,22 +106,18 @@ 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)
+**Note:** Seeding a torrent that can be downloaded by browser peers (i.e. with support for WebRTC) requires [webtorrent-hybrid](https://github.com/webtorrent/webtorrent-hybrid).
```js
var WebTorrent = require('webtorrent-hybrid')
var client = new WebTorrent()
-client.seed(__dirname + "/seedy.txt", function (torrent) {
+client.seed('/seed-me.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 !
-```
+where **seed-me.txt** is a text file which is going to be seeded as a torrent.
### Complete HTML page example