Merge pull request #1851 from therealadityashankar/improve-docs

added more explicit docs for certian key items (relevent github issue…

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 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