From 1dedf1936b169c3d7be7611ff3435bd6eb7aa94d Mon Sep 17 00:00:00 2001 From: Feross Aboukhadijeh Date: Wed, 29 Jan 2014 02:59:54 -0800 Subject: readme --- README.md | 35 ++++++++++++++++++++--------------- 1 file changed, 20 insertions(+), 15 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4e0482b..21686ab 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@ # ![WebTorrent](https://raw.github.com/feross/webtorrent/master/img/wordmark.png) -### WebTorrent - Streaming BitTorrent client for the browser - [![Build Status](http://img.shields.io/travis/feross/webtorrent.svg)](https://travis-ci.org/feross/webtorrent) [![NPM Version](http://img.shields.io/npm/v/webtorrent.svg)](https://npmjs.org/package/webtorrent) [![NPM](http://img.shields.io/npm/dm/webtorrent.svg)](https://npmjs.org/package/webtorrent) [![Gittip](http://img.shields.io/gittip/feross.svg)](https://www.gittip.com/feross/) +### WebTorrent - Streaming BitTorrent client for the browser + > Warning: This is pre-alpha software. Nothing works yet. **Watch/star to follow along with progress.** + ## Support development! I fight for the users. JavaScript and WebRTC are my sword and shield. Your donations allow me to spend more time vanquishing the enemy. @@ -16,12 +17,28 @@ I'm currently working on WebTorrent almost every night in my spare time. Please Send Bitcoins to: **1B6aystcqu8fd6ejzpmMFMPRqH9b86iiwh** or [donate easily via Coinbase](https://coinbase.com/checkouts/7c683397e33166651dedfebee6fb0f96). + +## Planned Features + +- **BitTorrent in your browser!** +- **No plugins** (uses WebRTC Data Channels for peer-to-peer data) +- **Streaming playback** (get first pieces first) + - Into `video` tag with MediaSource API when possible + - Flash player with JS bridge for other media types +- Works with .torrent files and magnet links +- Supports DHT (trackerless torrents) over WebRTC + - Extensions to DHT protocol to work over WebRTC + - DHT nodes do "peer introductions" so WebRTC can work without a centralized signaling server +- **Supports completely serverless, trackerless operation** + + ## Project Goal Build a browser BitTorrent client that requires no install (no plugin/extension/etc.) and fully-interoperates with the regular BitTorrent network. Use WebRTC Data Channels for peer-to-peer transport. Since WebTorrent is web-first, it's simple for users who do not understand .torrent files, magnet links, NATs, etc. By making BitTorrent easier, it will be accessible to new swathes of users who were previously intimidated, confused, or unwilling to install a program on their machine to participate. + ## NPM Modules Most of the active development is happening inside of smaller npm modules which will be used by WebTorrent. These are the modules I am writing to make WebTorrent work: @@ -48,19 +65,6 @@ Most of the active development is happening inside of smaller npm modules which ![node.js is shiny](http://feross.net/x/node.gif) -## Planned Features - -- **BitTorrent in your browser!** -- **No plugins** (uses WebRTC Data Channels for peer-to-peer data) -- **Streaming playback** (get first pieces first) - - Into `video` tag with MediaSource API when possible - - Flash player with JS bridge for other media types -- Works with .torrent files and magnet links -- Supports DHT (trackerless torrents) over WebRTC - - Extensions to DHT protocol to work over WebRTC - - DHT nodes do "peer introductions" so WebRTC can work without a centralized signaling server -- **Supports completely serverless, trackerless operation** - ## Interoperability with BitTorrent @@ -98,6 +102,7 @@ Most of the active development is happening inside of smaller npm modules which - Flash player for other media types - HTTP stream to VLC, like peerflix + ## Todo eventually - DHT over WebRTC (add new method for peer introduction) -- cgit v1.2.3