aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2014-09-23 00:51:59 +0000
committerMicah Lee <micah@micahflee.com>2014-09-23 00:51:59 +0000
commit0999bd678cbc0f16598d51917557b0fd54f44214 (patch)
tree4b849988b9c3fca7994b32a4174fbde558a7b421 /README.md
parentf5ddd23b70144a388e0ce3e20bb3339e5fd756e9 (diff)
downloadonionshare-0999bd678cbc0f16598d51917557b0fd54f44214.tar.gz
onionshare-0999bd678cbc0f16598d51917557b0fd54f44214.zip
version bump to 0.6, updated changelog, updated readme, and took new screenshots
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 15 insertions, 13 deletions
diff --git a/README.md b/README.md
index 99b29ffc..9e12532e 100644
--- a/README.md
+++ b/README.md
@@ -2,32 +2,34 @@
[![Build Status](https://travis-ci.org/micahflee/onionshare.png)](https://travis-ci.org/micahflee/onionshare)
-OnionShare lets you securely and anonymously share a file of any size with someone. It works by starting a web server, making it accessible as a Tor hidden service, and generating an unguessable URL to access and download the file. It doesn't require setting up a server on the internet somewhere or using a third party filesharing service. You host the file on your own computer and use a Tor hidden service to make it temporarily accessible over the internet. The other user just needs to use Tor Browser to download the file from you.
+OnionShare lets you securely and anonymously share files of any size. It works by starting a web server, making it accessible as a Tor hidden service, and generating an unguessable URL to access and download the files. It doesn't require setting up a server on the internet somewhere or using a third party filesharing service. You host the file on your own computer and use a Tor hidden service to make it temporarily accessible over the internet. The other user just needs to use Tor Browser to download the file from you.
-![Screenshot](/screenshot.png)
+![Sender Screenshot](/screenshot_sender.png)
+![Receiver Screenshot](/screenshot_receiver.png)
-OnionShare 0.3 is under active development and will be released soon. Features include:
+Features include:
-* A user-friendly GUI interface that works in Windows, Mac OS X, and Linux
+* A user-friendly drag-and-drop graphical user interface that works in Windows, Mac OS X, and Linux
+* Ability to share multiple files and folders at once
+* Support for multiple people downloading files at once
* Automatically copies the unguessable URL to your clipboard
-* Displays log of all requests, so you can see when someone is accessing your OnionShare service, or if someone is trying to guess your secret URL
-* Shows you the progress of the file transfer
+* Shows you the progress of file transfers
* When file is done transferring, automatically closes OnionShare to reduce the attack surface
+* Localized into several languages, and supports international unicode filenames
+* Designed to work in [Tails](https://tails.boum.org/), for high risk users
## Quick Start
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). You can also install OnionShare in your Tails persistent volume by following [these instructions](/tails/README.md) (requires Tails 1.1 or later).
-
-You can also install the command-line only version using pip: `sudo pip install onionshare`. When 0.3 is released the pip version will no longer be updated.
+You can set up your development environment to build OnionShare yourself by following [these instructions](/BUILD.md). You can also install OnionShare in your Tails persistent volume by following [these instructions](/tails/README.md).
## How to Use
-Before you can share a file, 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 hidden service.
+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 hidden service.
-Open OnionShare and browse to find the file you wish to share. It will show you a long, random-looking URL such as `http://v645bzpxmdtclpv3.onion/73b44511983c08bf29df40d0b1d00a69` 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 in the corner.
+Open OnionShare and drag and drop files and folders you wish to share, and start the server. It will show you a long, random-looking URL such as `http://cfxipsrhcujgebmu.onion/7aoo4nnzj3qurkafvzn7kket7u` 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 file to. If the file you're sending isn't very 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 a secret file then it's important to send this URL secrely. I recommend you use [Off-the-Record encrypted chat](https://pressfreedomfoundation.org/encryption-works#otr) to send the URL.
+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. I recommend you use [Off-the-Record encrypted chat](https://pressfreedomfoundation.org/encryption-works#otr) to send the URL.
-The person who is receiving the file 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.
+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.