Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs #694

Closed
wants to merge 10 commits into from
Next

Change magnetURI to torrentId

Change magnetURI to torrentId to avoid confusing, because client.add is not limited only to magnet URIs and there are many ways to define torrentId, e.g. HTTP(S) URL to a *.torrent file.
  • Loading branch information
FluorescentHallucinogen committed Mar 25, 2016
commit 8c6810a9e351f571337dd981ffc1d068c267ee5b
@@ -298,9 +298,9 @@ Here is a usage example:

```js
var client = new WebTorrent()
var magnetURI = 'magnet: ...'
var torrentId = 'magnet: ...'
client.add(magnetURI, function (torrent) {
client.add(torrentId, function (torrent) {
// create HTTP server for this torrent
var server = torrent.createServer()
server.listen(port) // start the server listening to a port
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.