diff options
author | Feross Aboukhadijeh <feross@feross.org> | 2014-11-17 03:50:13 +0300 |
---|---|---|
committer | Feross Aboukhadijeh <feross@feross.org> | 2014-11-17 03:50:13 +0300 |
commit | 8ce70f2771adaebdcc9ebbf3e4a8f85ae49bab58 (patch) | |
tree | 0dd9f1118bd1ef65b91e48c44768bca290263119 /README.md | |
parent | c11bff123d56c41f37c6f336114c9712ccc62388 (diff) |
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 22 |
1 files changed, 8 insertions, 14 deletions
@@ -71,6 +71,11 @@ it the first "hybrid" client. - **Donate bitcoin** if you believe in the vision and wish to support the project. Use **[Coinbase](https://www.coinbase.com/feross)**, or send to *1B6aystcqu8fd6ejzpmMFMPRqH9b86iiwh*. ([proof](https://keybase.io/feross)) +### WebTorrent in production + +- **[Instant](http://instant.io)** – Secure, anonymous, streaming file transfer [[code](https://github.com/feross/instant.io)] +- Your app here! (send a PR or open an issue with your app's URL) + ### Install With [npm](https://npmjs.org/), run: @@ -82,15 +87,11 @@ npm install webtorrent ### Usage WebTorrent is the first BitTorrent client that works in the browser, using open web -standards (no plugins, just HTML5 and WebRTC)! - -It's easy to get started! +standards (no plugins, just HTML5 and WebRTC)! It's easy to get started! #### In the browser -##### Download a file - -Downloading a file is simple: +##### Downloading a file is simple: ```js var WebTorrent = require('webtorrent') @@ -117,9 +118,7 @@ client.download(magnet_uri, function (torrent) { }) ``` -##### Seed a file - -Seeding a file is simple, too: +##### Seeding a file is simple, too: ```js var dragDrop = require('drag-drop/buffer') @@ -188,11 +187,6 @@ There are many supported streaming options: In addition to magnet uris, webtorrent supports [many ways to specify a torrent](#clientaddtorrentid-opts-function-ontorrent-torrent-). -### WebTorrent in production - -- **[Instant](http://instant.io)** – Secure, anonymous, streaming file transfer [[code](https://github.com/feross/instant.io)] -- Your app here! (send a PR or open an issue with the URL to your app) - ### API This API should work exactly the same in node and the browser. Open an issue if this is |