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:
authorDEADBLACKCLOVER <deadblackclover@protonmail.com>2020-07-12 21:30:04 +0300
committerGitHub <noreply@github.com>2020-07-12 21:30:04 +0300
commit24343c505907aa3df90ea036e01a491824118c51 (patch)
treefdd1b50b9ab876bddb22870261108db45e2481f1 /docs
parent321bc13307f7cd7776d2918a4cc217377c366991 (diff)
parenta805d2679c6dbacfb2b8ff385df94fd5236943af (diff)
Merge branch 'master' into patch-1
Diffstat (limited to 'docs')
-rw-r--r--docs/api.md2
-rw-r--r--docs/faq.md4
-rw-r--r--docs/get-started.md21
3 files changed, 26 insertions, 1 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/faq.md b/docs/faq.md
index 2e5c3de..2af53f5 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -102,6 +102,7 @@ WebTorrent is still pretty new, but it's already being used in cool ways:
- **[Come Over][comeover]** - Video stream sharing to watch movies together.
- **[Peer Web Site][peerwebsite]** - Realtime P2P Web Site using WebTorrent for files and WebRTC for text.
- **[CipherTorrent][cipher-torrent]** - Online and offline browser torrent client ([source code][cipher-torrent-source])
+- **[Slingcode][Slingcode]** - make, run, and share web apps P2P in the browser.
- ***Your app here – [Send a pull request][pr] with your URL!***
<!-- - **[PeerCloud][peercloud]** - Serverless websites via WebTorrent ([source code][peercloud-source]) -->
<!-- - **[Niagara][niagara]** - Video player webtorrent with subtitles (zipped .srt(s)) -->
@@ -174,10 +175,11 @@ There's also a list of WebTorrent-powered alternatives to centralized services h
[Files.fm]: https://files.fm
[imgest]: https://imgest.hashbase.io
[Bugout]: https://github.com/chr15m/bugout
+[Slingcode]: https://github.com/chr15m/slingcode
[p2p-media-loader]: https://github.com/novage/p2p-media-loader
[hubzilla]: https://hubzilla.org
[hubzilla-source]: https://github.com/demitas-ace/wtplayer/tree/master/wtplayer
-[comeover]: https://comeover.io
+[comeover]: https://www.comeover.io
[peerwebsite]: https://peerweb.site
[cipher-torrent]: https://torrent.cipherdogs.net
[cipher-torrent-source]: https://github.com/CipherDogs/cipher-torrent
diff --git a/docs/get-started.md b/docs/get-started.md
index bee3b9d..4f0872a 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