No description

Find a file

Feross Aboukhadijeh 1a01d7ed92 Use Material UI; improve Preferences Page New principles for our UI: - Components should use inline styles whenever possible - Let's shrink the size of main.css to < 100 lines over time so it just contains typography and basic styles - Always require just the individual component that is needed from Material UI so that the whole library doesn't get loaded (important for startup perf)		2016-08-23 03:06:03 -07:00
.github	Add subtitle support (via drag-n-drop) (#361 )	2016-04-10 16:42:18 -07:00
bin	Use Material UI; improve Preferences Page	2016-08-23 03:06:03 -07:00
src	Use Material UI; improve Preferences Page	2016-08-23 03:06:03 -07:00
static	Use Material UI; improve Preferences Page	2016-08-23 03:06:03 -07:00
.gitignore	gitignore folders	2016-08-23 03:05:33 -07:00
.nodemonignore	add `npm run watch` command	2016-08-23 03:05:33 -07:00
.travis.yml	Speed up Travis	2016-03-21 04:42:52 -07:00
AUTHORS.md	authors	2016-08-23 00:30:56 -07:00
CHANGELOG.md	changelog	2016-08-23 00:31:01 -07:00
CONTRIBUTING.md	Add Smoke Tests to CONTRIBUTING.md	2016-08-05 22:26:33 -07:00
index.js	Switch from virtualdom to React	2016-07-22 13:06:55 -07:00
LICENSE	WebTorrent, LLC	2016-05-19 16:43:51 -07:00
package.json	Use Material UI; improve Preferences Page	2016-08-23 03:06:03 -07:00
README.md	OS X -> Mac	2016-07-26 21:55:05 -07:00

README.md

WebTorrent Desktop

The streaming torrent client. For Mac, 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 Mac, 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 (Mac, Windows)
--package=[type] - Package single output type.
- deb - Debian package
- zip - Linux zip file
- dmg - Mac 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 Mac) will always be produced.

Windows build notes

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

On Mac, 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 how well the play button works. How often does it succeed? Time out? Show a missing codec error?

The app never sends personally identifying information, nor does it track which swarms you join.