maverick/webtorrent-desktop
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
921 commits 1 branch 0 tags 173 MiB
Find a file
Feross Aboukhadijeh 0df6198549 WebTorrent, LLC 
What is WebTorrent, LLC?

WebTorrent, LLC is the legal entity that runs the WebTorrent project.
WebTorrent is still, and always will be, non-profit, open source, free
software.

There are no plans to make a profit from WebTorrent.
2016-05-19 16:43:51 -07:00
.github Add subtitle support (via drag-n-drop) (#361) 2016-04-10 16:42:18 -07:00
bin package: remove unneeded 'npm prune' 2016-05-17 22:10:43 -07:00
main Fix the auto updater 2016-05-18 00:36:52 -07:00
renderer Clean up addSubtitles (#535) 2016-05-18 02:07:24 -07:00
static add default torrent: The WIRED CD (#401) 2016-04-13 00:24:16 -07:00
.gitignore .gitignore format 2016-02-16 17:22:24 -08:00
.travis.yml Speed up Travis 2016-03-21 04:42:52 -07:00
AUTHORS.md authors 2016-05-13 22:01:00 -07:00
CHANGELOG.md changelog 2016-05-18 00:49:06 -07:00
config.js WebTorrent, LLC 2016-05-19 16:43:51 -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 WebTorrent, LLC 2016-05-19 16:43:51 -07:00
README.md WebTorrent, LLC 2016-05-19 16:43:51 -07:00

README.md


WebTorrent
WebTorrent Desktop

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

Gitter Travis Release

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.)

Code Style

js-standard-style

License

MIT. Copyright (c) WebTorrent, LLC.