diff options
| author | Micah Lee <micah@micahflee.com> | 2016-12-22 13:43:07 -0800 |
|---|---|---|
| committer | Micah Lee <micah@micahflee.com> | 2016-12-22 13:43:07 -0800 |
| commit | 0f36354dc57b8170f32cba3e2085cc1e51205723 (patch) | |
| tree | 0d074a4e51ea40db734b6bc767c97e9b579b7569 /README.md | |
| parent | e46c4f510ac2d7bac3bbe77eed26ed3083098204 (diff) | |
| download | onionshare-0f36354dc57b8170f32cba3e2085cc1e51205723.tar.gz onionshare-0f36354dc57b8170f32cba3e2085cc1e51205723.zip | |
Removing instructions from readme, and adding link to wiki instead
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 2 insertions, 18 deletions
@@ -21,24 +21,8 @@ If you're interested in exactly what OnionShare does and does not protect agains ## Quick Start +Check out [the wiki](https://github.com/micahflee/onionshare/wiki) for information about how to use OnionShare and it's various features. + You can download OnionShare to install on your computer from <https://onionshare.org/>. You can set up your development environment to build OnionShare yourself by following [these instructions](/BUILD.md). - -## How to Use - -Before you can share files, you need to open [Tor Browser](https://www.torproject.org/) in the background. This will provide the Tor service that OnionShare uses to start the onion service. - -Open OnionShare and drag and drop files and folders you wish to share, and click Start Sharing. It will show you a .onion URL such as `http://asxmi4q6i7pajg2b.onion/egg-cain` and copy it to your clipboard. This is the secret URL that can be used to download the file you're sharing. If you'd like multiple people to be able to download this file, uncheck the "close automatically" checkbox. - -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. |