aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2016-09-06 11:56:09 -0700
committerMicah Lee <micah@micahflee.com>2016-09-06 11:56:09 -0700
commit9c250fc4e447953c82f560db33f734be655b1c43 (patch)
tree50f08a1443439f14093a34ddb998233f5ab8d24d /README.md
parente093c7298a687d8b1bf5c01b0193ca38f720e6fd (diff)
downloadonionshare-9c250fc4e447953c82f560db33f734be655b1c43.tar.gz
onionshare-9c250fc4e447953c82f560db33f734be655b1c43.zip
Add instructions for using CLI version to README, and add supporting Windows/OSX CLI to changelog
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7f680855..b3531938 100644
--- a/README.md
+++ b/README.md
@@ -34,3 +34,11 @@ Open OnionShare and drag and drop files and folders you wish to share, and click
Send this URL to the person you're trying to send the files to. If the files you're sending aren't secret, you can use normal means of sending the URL: emailing it, posting it to Facebook or Twitter, etc. If you're trying to send secret files then it's important to send this URL securely.
The person who is receiving the files doesn't need OnionShare. All they need is to open the URL you send them in Tor Browser to be able to download the file.
+
+## Using the command line version
+
+In Linux: Just run `onionshare` from the terminal.
+
+In Windows: Add `C:\Program Files (x86)\OnionShare` to your PATH. Now you can run `onionshare.exe` in a command prompt.
+
+In Mac OS X: Run `ln -s /Applications/OnionShare.app/Contents/MacOS/onionshare /usr/local/bin`. Now you can run `onionshare` from the terminal.