summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHenrique Pereira <ikkibr@gmail.com>2014-05-23 12:37:10 -0300
committerHenrique Pereira <ikkibr@gmail.com>2014-05-23 12:37:10 -0300
commit13fc2ea0e03e3d052fd44e55f3d7e125b12eea2d (patch)
treee5c95045e0e9df73537a6df06e3df92acde8db43 /README.md
parentf355296c01ef2a378c5a6676eeaa013871300a25 (diff)
downloadonionshare-13fc2ea0e03e3d052fd44e55f3d7e125b12eea2d.tar.gz
onionshare-13fc2ea0e03e3d052fd44e55f3d7e125b12eea2d.zip
Refactored onionshare
Packaged, refactored the main function, added a setup.py, added a better .gitignore
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2a7d29df..1f59f990 100644
--- a/README.md
+++ b/README.md
@@ -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