Files
webtorrent-desktop/README.md
2016-03-11 15:23:41 -08:00

60 lines
1.1 KiB
Markdown

<h1 align="center">
<br>
<img src="https://webtorrent.io/img/WebTorrent.png" alt="WebTorrent" width="200">
<br>
WebTorrent.app
<br>
<br>
</h1>
<h4 align="center">The streaming torrent client. For OS X, Windows, and Linux.</h4>
<p align="center">
<a href="https://gitter.im/feross/webtorrent">
<img src="https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg"
alt="Gitter">
</a>
<a href="https://travis-ci.org/feross/webtorrent-app">
<img src="https://img.shields.io/travis/feross/webtorrent-app/master.svg"
alt="Travis Build">
</a>
</p>
## 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).