Refactored onionshare

Packaged, refactored the main function, added a setup.py, added a better
.gitignore
This commit is contained in:
Henrique Pereira 2014-05-23 12:37:10 -03:00
parent f355296c01
commit 13fc2ea0e0
6 changed files with 270 additions and 3 deletions

View file

@ -8,6 +8,8 @@ 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.
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`.
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