Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/webtorrent/webtorrent.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFeross Aboukhadijeh <feross@feross.org>2015-01-14 08:25:32 +0300
committerFeross Aboukhadijeh <feross@feross.org>2015-01-14 08:25:32 +0300
commit0b149014ae8db168be1882408ff5bd3829156059 (patch)
tree0442c31fdbf1cb258ea26daca81371463e322056
parenteeeeceafaeba94973398b2b050809cfee0be6cfb (diff)
readme
-rw-r--r--README.md40
1 files changed, 23 insertions, 17 deletions
diff --git a/README.md b/README.md
index 734b2b2..9e750db 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,20 @@
# ![WebTorrent](img/wordmark.png)
+[![Gitter][webtorrent-gitter-image]][webtorrent-gitter-url]
[![Build Status][webtorrent-ti]][webtorrent-tu]
[![NPM Version][webtorrent-ni]][webtorrent-nu]
[![NPM Downloads][webtorrent-downloads-image]][webtorrent-downloads-url]
-[![Gratipay][webtorrent-gratipay-image]][webtorrent-gratipay-url]
+
+[![Sauce Test Status][webtorrent-sauce-image]][webtorrent-sauce-url]
### Streaming torrent client for node & the browser
-[![Gitter][webtorrent-gitter-image]][webtorrent-gitter-url]
**WebTorrent** is a streaming torrent client for **node.js** and the **browser**. YEP,
THAT'S RIGHT. THE BROWSER. It's written completely in JavaScript – the language of the web
– so the same code works in both runtimes.
+
In node, this module is a simple torrent client, using TCP and UDP to talk to
normal torrent clients. Soon, it will gain the ability to swarm with web peers, making
it the first "hybrid" client.
@@ -64,16 +66,28 @@ for WebTorrent (and WebRTC) so they can swarm with both normal *and* web peers.
- Stream video torrents into a `<video>` tag (`webm (vp8, vp9)` or `mp4 (h.264)`)
- Supports Chrome, Firefox, and Opera.
-[![Sauce Test Status][webtorrent-sauce-image]][webtorrent-sauce-url]
-
#### Node-only features
- Stream to **AirPlay**, **Chromecast**, **VLC player**, and many other devices/players
+### Install
+
+To install WebTorrent for use in node or the browser with `require('webtorrent')`, run:
+
+```bash
+npm install webtorrent
+```
+
+To install a `webtorrent` command line program, run:
+
+```bash
+npm install webtorrent -g
+```
+
### Ways to help
-- **Join us in IRC** on freenode at `#webtorrent` if you want to help with development, or
- you just want to hang out with some cool mad science hackers :)
+- **Join us in [Gitter][webtorrent-gitter-url]** or on freenode at `#webtorrent` to help
+ with development or to hang out with some cool mad science hackers :)
- **[Create a new issue](https://github.com/feross/webtorrent/issues/new)** to report bugs
- **[Fix an issue](https://github.com/feross/webtorrent/issues?state=open)**. Note:
WebTorrent is an [OPEN Open Source Project](CONTRIBUTING.md)!
@@ -82,17 +96,9 @@ for WebTorrent (and WebRTC) so they can swarm with both normal *and* web peers.
### WebTorrent in production
-- **[Instant](http://instant.io)** – Secure, anonymous, streaming file transfer [[code](https://github.com/feross/instant.io)]
+- **[Instant](http://instant.io)** – Secure, anonymous, streaming file transfer ([source 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:
-
-```bash
-npm install webtorrent
-```
-
### Usage
WebTorrent is the first BitTorrent client that works in the browser, using open web
@@ -197,7 +203,7 @@ WebTorrent also works in node.js, using the *same npm module!* It's mad science!
WebTorrent is available as a command line app. Here's how to use it:
```bash
-$ npm install -g webtorrent
+$ npm install webtorrent -g
$ webtorrent --help
```
@@ -523,7 +529,7 @@ These are the main modules that make up WebTorrent:
[webtorrent-gratipay-url]: https://gratipay.com/feross/
[webtorrent-sauce-image]: https://saucelabs.com/browser-matrix/webtorrent.svg
[webtorrent-sauce-url]: https://saucelabs.com/u/webtorrent
-[webtorrent-gitter-image]: https://badges.gitter.im/Join%20Chat.svg
+[webtorrent-gitter-image]: https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg?style=flat
[webtorrent-gitter-url]: https://gitter.im/feross/webtorrent
[bittorrent-dht]: https://github.com/feross/bittorrent-dht