From 3fbcb459de6efccc45764286010fd0de7876b01c Mon Sep 17 00:00:00 2001 From: Alex Kern Date: Tue, 19 May 2015 12:49:23 +0200 Subject: [PATCH] Add instructions for installing filepizza's binary --- README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index cd879ee..74225d4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![wordmark](static/images/wordmark.png) -###Free peer-to-peer file transfers in your browser +### Free peer-to-peer file transfers in your browser Cooked up by [Alex Kern](http://kern.io) & [Neeraj Baid](http://neeraj.io) while eating *Sliver* @ UC Berkeley. @@ -12,20 +12,28 @@ FilePizza enables fast and private peer-to-peer file transfers in your web brows By using [WebRTC](http://www.webrtc.org), FilePizza eliminates the initial upload traditionally required when sharing files via file sharing services (e.g. Dropbox). Instead of transmitting files through an intermediary server, the sender initializes a transfer and receives a "tempalink" they can distribute. When recipients click on this link, they connect directly to the sender’s browser to complete the download. Because the file never touches the server, the transfer is fast, private, and secure. For larger files, this is an especially big deal. -## Usage - - $ npm install - $ npm start - -You can specify the port that FilePizza's HTTP server uses by setting the `PORT` environment variable: - - $ env PORT=8080 npm start +A hosted instance of FilePizza is available at [file.pizza](http://file.pizza). ## Requirements * node `0.12.x` * npm `2.x.x` +## Installation + + $ npm install filepizza -g + $ filepizza + +You can specify the port that FilePizza's HTTP server uses by setting the `PORT` environment variable (default 3000): + + $ env PORT=8080 filepizza + +## Development + + $ git clone https://github.com/kern/filepizza.git + $ npm install + $ npm start + ## Troubleshooting If you receive a `Error: EMFILE, too many open files` error when running `npm