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

Merge the webtorrent-www API docs (for #507) #682

Merged
merged 5 commits into from Mar 16, 2016
Merged
Changes from 1 commit
Commits
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

docs formatting

  • Loading branch information
feross committed Mar 16, 2016
commit 566c888f18426bdd1ce28cbdd70ec45e746627bd
@@ -21,7 +21,7 @@ Create a new `WebTorrent` instance.

If `opts` is specified, then the default options (shown below) will be overridden.

```json
```js
{
dht: Boolean|Object, // Enable DHT (default=true), or options object for DHT
maxConns: Number, // Max number of connections per torrent (default=55)
@@ -48,7 +48,7 @@ Start downloading a new torrent. Aliased as `client.download`.

If `opts` is specified, then the default options (shown below) will be overridden.

```json
```js
{
announce: [], // Torrent trackers to use (added to list in .torrent or magnet uri)
getAnnounceOpts: function, // Custom callback to allow sending extra parameters to the tracker
@@ -337,7 +337,7 @@ swarm first.
You can pass `opts` to stream only a slice of a file.
```json
```js
{
start: startByte,
end: endByte
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.