Files
webtorrent-desktop/README.md
Feross Aboukhadijeh d57a2cfd71 readme
2016-03-10 23:15:06 -08:00

52 lines
1.1 KiB
Markdown

# WebTorrent.app
[![Gitter][webtorrent-gitter-image]][webtorrent-gitter-url]
[![Travis Build][webtorrent-app-travis-image]][webtorrent-app-travis-url]
[webtorrent-gitter-image]: https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg
[webtorrent-gitter-url]: https://gitter.im/feross/webtorrent
[webtorrent-app-travis-image]: https://img.shields.io/travis/feross/webtorrent-app/master.svg
[webtorrent-app-travis-url]: https://travis-ci.org/feross/webtorrent-app
#### WebTorrent, the streaming torrent client. For OS X, Windows, and Linux.
<img src="https://webtorrent.io/img/WebTorrent.png" alt="WebTorrent" width="100">
## Install
WebTorrent.app is still under very active development. Expect a release very soon!
## Screenshot
<p align="center">
<img src="./static/screenshot.png" width="562" height="630" alt="screenshot" align="center">
</p>
## 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
```
## License
MIT. Copyright (c) [Feross Aboukhadijeh](http://feross.org).