minor readme changes

This commit is contained in:
Micah Lee 2014-05-24 20:35:30 -04:00
parent 0740ce3c3c
commit e783d06a08

View file

@ -8,11 +8,11 @@ OnionShare lets you securely and anonymously share a file of any size with someo
At the moment OnionShare is a command line program. It works in Mac OS X, GNU/Linux, and Windows (see special Windows and Tails instructions below). To get started, either git clone the onionshare repository or [download this zip file](https://github.com/micahflee/onionshare/archive/master.zip) and extract it. Open a terminal and navigate to the onionshare directory. At the moment OnionShare is a command line program. It works in Mac OS X, GNU/Linux, and Windows (see special Windows and Tails instructions below). To get started, either git clone the onionshare repository or [download this zip file](https://github.com/micahflee/onionshare/archive/master.zip) and extract it. Open a terminal and navigate to the onionshare directory.
You can also install onionshare by using PIP or easy_instal. On pip you can type `pip install onionshare` and on easy_install your can use `easy_install onionshare`. You can also install onionshare by using pip or easy_install. On pip you can type `pip install onionshare` and on easy_install your can use `easy_install onionshare`.
OnionShare relies on Tor. You need to either have a system Tor installed (`sudo apt-get install tor`), or you can open Tor Browser so that OnionShare can use the Tor server provided there. Start Tor, and then run `onionshare.py`, passing in the file that you want to share, like this: OnionShare relies on Tor. You need to either have a system Tor installed (`sudo apt-get install tor`), or you can open Tor Browser so that OnionShare can use the Tor server provided there. Start Tor, and then run `onionshare.py`, passing in the file that you want to share, like this:
[user@dev onionshare]$ ./onionshare.py ~/Desktop/secrets.pdf [user@dev onionshare]$ ./onionshare.py ~/Desktop/secrets.pdf
Connecting to Tor ControlPort to set up hidden service on port 26828 Connecting to Tor ControlPort to set up hidden service on port 26828
Give this URL to the person you're sending the file to: Give this URL to the person you're sending the file to: