No description

Find a file

DC fe5ea31f2c authors		2016-06-23 07:32:28 -07:00
.github	Add subtitle support (via drag-n-drop) (#361 )	2016-04-10 16:42:18 -07:00
bin	Make check-deps handle older verions of node	2016-06-23 07:09:49 -07:00
main	Windows Thumbnail Bar	2016-06-23 07:12:32 -07:00
renderer	Windows Thumbnail Bar	2016-06-23 07:12:32 -07:00
static	Windows Thumbnail Bar	2016-06-23 07:12:32 -07:00
.gitignore	Add additional video player keyboard shortcuts (#275 )	2016-05-23 00:15:57 -07:00
.travis.yml	Speed up Travis	2016-03-21 04:42:52 -07:00
AUTHORS.md	authors	2016-06-23 07:32:28 -07:00
CHANGELOG.md	changelog	2016-06-03 15:10:11 -07:00
config.js	Telemetry	2016-06-20 22:33:17 -07:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2016-04-01 21:27:47 -07:00
crash-reporter.js	remove unneeded console.log	2016-05-11 17:52:18 +02:00
index.js	move console.time/timeEnd to same file	2016-05-11 17:56:20 +02:00
LICENSE	WebTorrent, LLC	2016-05-19 16:43:51 -07:00
package.json	0.8.0	2016-06-23 07:31:18 -07:00
README.md	Telemetry: add Privacy section to README	2016-06-21 21:58:15 -07:00

README.md

WebTorrent Desktop

The streaming torrent client. For OS X, Windows, and Linux.

Install

WebTorrent Desktop is still under very active development. You can download the latest version from the releases page.

Screenshot

screenshot

How to Contribute

Install dependencies

$ npm install

Run app

$ npm start

Package app

Builds app binaries for OS X, Linux, and Windows.

$ npm run package

To build for one platform:

$ npm run package -- [platform]

Where [platform] is darwin, linux, win32, or all (default).

The following optional arguments are available:

--sign - Sign the application (OS X, Windows)
--package=[type] - Package single output type.
- deb - Debian package
- zip - Linux zip file
- dmg - OS X disk image
- exe - Windows installer
- portable - Windows portable app
- all - All platforms (default)

Note: Even with the --package option, the auto-update files (.nupkg for Windows, *-darwin.zip for OS X) will always be produced.

Windows build notes

To package the Windows app from non-Windows platforms, Wine needs to be installed.

On OS X, first install XQuartz, then run:

brew install wine

(Requires the Homebrew package manager.)

Privacy

WebTorrent Desktop collects some basic usage stats to help us make the app better. For example, we track what OSs are users are on, and how well the play button works (how often does it succeed? time out? show a missing codec error?). The app never sends personally identifying or other private info.