diff options
author | Feross Aboukhadijeh <feross@feross.org> | 2017-04-15 00:34:02 +0300 |
---|---|---|
committer | Feross Aboukhadijeh <feross@feross.org> | 2017-04-15 00:34:02 +0300 |
commit | b4e79a368d60b5bea9d705676ee76e6f9d7c0a4e (patch) | |
tree | 1b20c7f9c6aefc059e67f6dc93d36fb02929447b /README.md | |
parent | eb6c827cdee108c7f3983eda2c2a43ac5cd0a2d9 (diff) |
feross -> webtorrent
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 86 |
1 files changed, 42 insertions, 44 deletions
@@ -10,9 +10,9 @@ <h4 align="center">The streaming torrent client. For node.js and the web.</h4> <p align="center"> - <a href="https://gitter.im/feross/webtorrent"><img src="https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg" alt="gitter"></a> - <a href="https://travis-ci.org/feross/webtorrent"><img src="https://img.shields.io/travis/feross/webtorrent/master.svg" alt="travis"></a> - <a href="https://ci.appveyor.com/project/feross/webtorrent"><img src="https://ci.appveyor.com/api/projects/status/cgu85xlgl72uoswq/branch/master?svg=true" alt="appveyor"></a> + <a href="https://gitter.im/webtorrent/webtorrent"><img src="https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg" alt="gitter"></a> + <a href="https://travis-ci.org/webtorrent/webtorrent"><img src="https://img.shields.io/travis/webtorrent/webtorrent/master.svg" alt="travis"></a> + <a href="https://ci.appveyor.com/project/webtorrent/webtorrent"><img src="https://ci.appveyor.com/api/projects/status/cgu85xlgl72uoswq/branch/master?svg=true" alt="appveyor"></a> <a href="https://www.npmjs.com/package/webtorrent"><img src="https://img.shields.io/npm/v/webtorrent.svg" alt="npm version"></a> <a href="https://www.npmjs.com/package/webtorrent"><img src="https://img.shields.io/npm/dm/webtorrent.svg" alt="npm downloads"></a> <a href="https://standardjs.com"><img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard - JavaScript Style Guide"></a> @@ -43,7 +43,7 @@ peer"** can only connect to other clients that support WebTorrent/WebRTC. To seed files to web peers, use a client that supports WebTorrent, e.g. [WebTorrent Desktop][webtorrent-desktop], a desktop client with a familiar UI that can connect to web peers, -[webtorrent-hybrid](https://github.com/feross/webtorrent-hybrid), a command line program, +[webtorrent-hybrid](https://github.com/webtorrent/webtorrent-hybrid), a command line program, or [Instant.io](https://instant.io/), a website. Established torrent clients like **Vuze** have [already added WebTorrent support](https://wiki.vuze.com/w/WebTorrent) so they can connect to both normal *and* web peers. We hope other clients will follow. @@ -60,11 +60,11 @@ they can connect to both normal *and* web peers. We hope other clients will foll - Fetches pieces from the network on-demand so seeking is supported (even before torrent is finished) - Seamlessly switches between sequential and rarest-first piece selection strategy - Supports advanced torrent client features - - **magnet uri** support via **[ut_metadata](https://github.com/feross/ut_metadata)** - - **peer discovery** via **[dht](https://github.com/feross/bittorrent-dht)**, - **[tracker](https://github.com/feross/bittorrent-tracker)**, and + - **magnet uri** support via **[ut_metadata](https://github.com/webtorrent/ut_metadata)** + - **peer discovery** via **[dht](https://github.com/webtorrent/bittorrent-dht)**, + **[tracker](https://github.com/webtorrent/bittorrent-tracker)**, and **[ut_pex](https://github.com/fisch0920/ut_pex)** - - **[protocol extension api](https://github.com/feross/bittorrent-protocol#extension-api)** + - **[protocol extension api](https://github.com/webtorrent/bittorrent-protocol#extension-api)** for adding new extensions - **Comprehensive test suite** (runs completely offline, so it's reliable and fast) @@ -91,7 +91,7 @@ npm install webtorrent ``` To install a `webtorrent` -[command line program](https://github.com/feross/webtorrent-cli), run: +[command line program](https://github.com/webtorrent/webtorrent-cli), run: ```bash npm install webtorrent-cli -g @@ -104,8 +104,8 @@ To install a WebTorrent desktop appliation for Mac, Windows, or Linux, see - **Join us in [Gitter][webtorrent-gitter-url]** or on freenode at `#webtorrent` to help with development or to hang out with some 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)**. WebTorrent +- **[Create a new issue](https://github.com/webtorrent/webtorrent/issues/new)** to report bugs +- **[Fix an issue](https://github.com/webtorrent/webtorrent/issues?state=open)**. WebTorrent is an [OPEN Open Source Project](CONTRIBUTING.md)! ### Who is using WebTorrent today? @@ -212,13 +212,13 @@ MaxCDN) for easy inclusion on your site: WebTorrent also works in node.js, using the *same npm package!* It's mad science! **NOTE**: To connect to "web peers" (browsers) in addition to normal BitTorrent peers, use -[webtorrent-hybrid](https://github.com/feross/webtorrent-hybrid) which includes WebRTC +[webtorrent-hybrid](https://github.com/webtorrent/webtorrent-hybrid) which includes WebRTC support for node. #### As a command line app WebTorrent is also available as a -[command line app](https://github.com/feross/webtorrent-cli). Here's how to use it: +[command line app](https://github.com/webtorrent/webtorrent-cli). Here's how to use it: ```bash $ npm install webtorrent-cli -g @@ -281,17 +281,17 @@ These are the main modules that make up WebTorrent: | [ut_metadata][ut_metadata] | [![][ut_metadata-ti]][ut_metadata-tu] | [![][ut_metadata-ni]][ut_metadata-nu] | metadata for magnet uris (protocol extension) | [ut_pex][ut_pex] | [![][ut_pex-ti]][ut_pex-tu] | [![][ut_pex-ni]][ut_pex-nu] | peer discovery (protocol extension) -[webtorrent]: https://github.com/feross/webtorrent -[webtorrent-gitter-url]: https://gitter.im/feross/webtorrent -[webtorrent-ti]: https://img.shields.io/travis/feross/webtorrent/master.svg -[webtorrent-tu]: https://travis-ci.org/feross/webtorrent +[webtorrent]: https://github.com/webtorrent/webtorrent +[webtorrent-gitter-url]: https://gitter.im/webtorrent/webtorrent +[webtorrent-ti]: https://img.shields.io/travis/webtorrent/webtorrent/master.svg +[webtorrent-tu]: https://travis-ci.org/webtorrent/webtorrent [webtorrent-ni]: https://img.shields.io/npm/v/webtorrent.svg [webtorrent-nu]: https://www.npmjs.com/package/webtorrent [webtorrent-desktop]: https://webtorrent.io/desktop -[bittorrent-dht]: https://github.com/feross/bittorrent-dht -[bittorrent-dht-ti]: https://img.shields.io/travis/feross/bittorrent-dht/master.svg -[bittorrent-dht-tu]: https://travis-ci.org/feross/bittorrent-dht +[bittorrent-dht]: https://github.com/webtorrent/bittorrent-dht +[bittorrent-dht-ti]: https://img.shields.io/travis/webtorrent/bittorrent-dht/master.svg +[bittorrent-dht-tu]: https://travis-ci.org/webtorrent/bittorrent-dht [bittorrent-dht-ni]: https://img.shields.io/npm/v/bittorrent-dht.svg [bittorrent-dht-nu]: https://www.npmjs.com/package/bittorrent-dht @@ -301,33 +301,33 @@ These are the main modules that make up WebTorrent: [bittorrent-peerid-ni]: https://img.shields.io/npm/v/bittorrent-peerid.svg [bittorrent-peerid-nu]: https://www.npmjs.com/package/bittorrent-peerid -[bittorrent-protocol]: https://github.com/feross/bittorrent-protocol -[bittorrent-protocol-ti]: https://img.shields.io/travis/feross/bittorrent-protocol/master.svg -[bittorrent-protocol-tu]: https://travis-ci.org/feross/bittorrent-protocol +[bittorrent-protocol]: https://github.com/webtorrent/bittorrent-protocol +[bittorrent-protocol-ti]: https://img.shields.io/travis/webtorrent/bittorrent-protocol/master.svg +[bittorrent-protocol-tu]: https://travis-ci.org/webtorrent/bittorrent-protocol [bittorrent-protocol-ni]: https://img.shields.io/npm/v/bittorrent-protocol.svg [bittorrent-protocol-nu]: https://www.npmjs.com/package/bittorrent-protocol -[bittorrent-tracker]: https://github.com/feross/bittorrent-tracker -[bittorrent-tracker-ti]: https://img.shields.io/travis/feross/bittorrent-tracker/master.svg -[bittorrent-tracker-tu]: https://travis-ci.org/feross/bittorrent-tracker +[bittorrent-tracker]: https://github.com/webtorrent/bittorrent-tracker +[bittorrent-tracker-ti]: https://img.shields.io/travis/webtorrent/bittorrent-tracker/master.svg +[bittorrent-tracker-tu]: https://travis-ci.org/webtorrent/bittorrent-tracker [bittorrent-tracker-ni]: https://img.shields.io/npm/v/bittorrent-tracker.svg [bittorrent-tracker-nu]: https://www.npmjs.com/package/bittorrent-tracker -[create-torrent]: https://github.com/feross/create-torrent -[create-torrent-ti]: https://img.shields.io/travis/feross/create-torrent/master.svg -[create-torrent-tu]: https://travis-ci.org/feross/create-torrent +[create-torrent]: https://github.com/webtorrent/create-torrent +[create-torrent-ti]: https://img.shields.io/travis/webtorrent/create-torrent/master.svg +[create-torrent-tu]: https://travis-ci.org/webtorrent/create-torrent [create-torrent-ni]: https://img.shields.io/npm/v/create-torrent.svg [create-torrent-nu]: https://www.npmjs.com/package/create-torrent -[magnet-uri]: https://github.com/feross/magnet-uri -[magnet-uri-ti]: https://img.shields.io/travis/feross/magnet-uri/master.svg -[magnet-uri-tu]: https://travis-ci.org/feross/magnet-uri +[magnet-uri]: https://github.com/webtorrent/magnet-uri +[magnet-uri-ti]: https://img.shields.io/travis/webtorrent/magnet-uri/master.svg +[magnet-uri-tu]: https://travis-ci.org/webtorrent/magnet-uri [magnet-uri-ni]: https://img.shields.io/npm/v/magnet-uri.svg [magnet-uri-nu]: https://www.npmjs.com/package/magnet-uri -[parse-torrent]: https://github.com/feross/parse-torrent -[parse-torrent-ti]: https://img.shields.io/travis/feross/parse-torrent/master.svg -[parse-torrent-tu]: https://travis-ci.org/feross/parse-torrent +[parse-torrent]: https://github.com/webtorrent/parse-torrent +[parse-torrent-ti]: https://img.shields.io/travis/webtorrent/parse-torrent/master.svg +[parse-torrent-tu]: https://travis-ci.org/webtorrent/parse-torrent [parse-torrent-ni]: https://img.shields.io/npm/v/parse-torrent.svg [parse-torrent-nu]: https://www.npmjs.com/package/parse-torrent @@ -337,15 +337,15 @@ These are the main modules that make up WebTorrent: [render-media-ni]: https://img.shields.io/npm/v/render-media.svg [render-media-nu]: https://www.npmjs.com/package/render-media -[torrent-discovery]: https://github.com/feross/torrent-discovery -[torrent-discovery-ti]: https://img.shields.io/travis/feross/torrent-discovery/master.svg -[torrent-discovery-tu]: https://travis-ci.org/feross/torrent-discovery +[torrent-discovery]: https://github.com/webtorrent/torrent-discovery +[torrent-discovery-ti]: https://img.shields.io/travis/webtorrent/torrent-discovery/master.svg +[torrent-discovery-tu]: https://travis-ci.org/webtorrent/torrent-discovery [torrent-discovery-ni]: https://img.shields.io/npm/v/torrent-discovery.svg [torrent-discovery-nu]: https://www.npmjs.com/package/torrent-discovery -[ut_metadata]: https://github.com/feross/ut_metadata -[ut_metadata-ti]: https://img.shields.io/travis/feross/ut_metadata/master.svg -[ut_metadata-tu]: https://travis-ci.org/feross/ut_metadata +[ut_metadata]: https://github.com/webtorrent/ut_metadata +[ut_metadata-ti]: https://img.shields.io/travis/webtorrent/ut_metadata/master.svg +[ut_metadata-tu]: https://travis-ci.org/webtorrent/ut_metadata [ut_metadata-ni]: https://img.shields.io/npm/v/ut_metadata.svg [ut_metadata-nu]: https://www.npmjs.com/package/ut_metadata @@ -384,8 +384,6 @@ localStorage.removeItem('debug') - May 2014 (JS.LA) – [How I Built a BitTorrent Client in the Browser](https://vimeo.com/97324247) (progress update; node client working) - Oct 2013 (RealtimeConf) – [WebRTC Black Magic](https://vimeo.com/77265280) (first mention of idea for WebTorrent) -[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard) - ### License -MIT. Copyright (c) [WebTorrent, LLC](https://webtorrent.io). +MIT. Copyright (c) [Feross Aboukhadijeh](https://feross.org) and [WebTorrent, LLC](https://webtorrent.io). |