Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support seeding a file from filesystem (path string) #209

Merged
merged 6 commits into from Dec 17, 2014
Merged

readme

  • Loading branch information
feross committed Dec 16, 2014
commit 8e6503ab5dcbc698c02de88b5e0f65e015269591
@@ -1,14 +1,17 @@
# ![WebTorrent](img/wordmark.png)

### Streaming torrent client for node & the browser

[![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]

### WebTorrent – Streaming torrent client for node & the browser
[![Sauce Test Status][webtorrent-sauce-image]][webtorrent-sauce-url]

WebTorrent is a streaming torrent client that works in 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.
**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 the browser, WebTorrent uses **WebRTC** (data channels) for peer-to-peer transport.
It can be used **without** browser plugins, extensions, or installations. It's Just
@@ -33,8 +36,6 @@ it the first "hybrid" client.

> Warning: This is pre-alpha software. **Watch/star to follow along with progress.**
[![Sauce Test Status][webtorrent-sauce-image]][webtorrent-sauce-url]

### Features

- **Torrent client for node.js & the browser** (same npm module!)
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.