diff options
| -rw-r--r-- | CONTRIBUTING.md | 3 | ||||
| -rw-r--r-- | README.md | 10 |
2 files changed, 7 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b3e306..ef04ed8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,6 +13,7 @@ There are a few basic ground-rules for contributors: 1. **External API changes and significant modifications** ought to be subject to an **internal pull-request** to solicit feedback from other contributors. 1. Internal pull-requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor. 1. Contributors should attempt to adhere to the prevailing code-style. +1. Run npm test locally before submitting your PR, to catch any easy to miss style & testing issues ## Releases @@ -22,4 +23,4 @@ Declaring formal releases remains the prerogative of the project maintainer. This is an experiment and feedback is welcome! This document may also be subject to pull requests or changes by contributors where you believe you have something valuable to add or change. -Thanks to [Rod Vagg](https://github.com/rvagg) and the [LevelUP](https://github.com/rvagg/node-levelup) project for coming up with the idea of "OPEN Open Source"! +Thanks to [Rod Vagg](https://github.com/rvagg) and the [LevelUP](https://github.com/rvagg/node-levelup) project for coming up with this model for open source contribution. @@ -73,7 +73,7 @@ for WebRTC and the WebTorrent extensions so they can swarm with peers from both With [npm](https://npmjs.org/), run: ```bash -npm install webtorrent -g +npm install webtorrent ``` ### Usage @@ -152,10 +152,10 @@ WebTorrent also works in node.js, using the *same npm module!* It's mad science! #### As a command line app -WebTorrent is available as a command line app Here's how to use it: +WebTorrent is available as a command line app. Here's how to use it: ```bash -$ npm install webtorrent -g +$ npm install -g webtorrent $ webtorrent --help ``` @@ -163,8 +163,6 @@ To download a torrent: ```bash $ webtorrent magnet_uri - -$ webtorrent /path/to/file.torrent ``` To stream a torrent to a device like **AirPlay** or **Chromecast**, just pass a flag: @@ -185,6 +183,8 @@ There are many supported streaming options: --xbmc stream to XBMC ``` +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)] |