diff options
| author | Micah Lee <micah@micahflee.com> | 2017-02-22 11:27:27 -0800 |
|---|---|---|
| committer | Micah Lee <micah@micahflee.com> | 2017-02-22 11:27:27 -0800 |
| commit | 9f0f73260bfbe284e72201a5fadc8a1cd46638a5 (patch) | |
| tree | 48260b45024151869a15ce4094670297acc78e11 /README.md | |
| parent | ab20311f6e9faae3399cef125f7acecd7a7a9adf (diff) | |
| download | onionshare-9f0f73260bfbe284e72201a5fadc8a1cd46638a5.tar.gz onionshare-9f0f73260bfbe284e72201a5fadc8a1cd46638a5.zip | |
Delete the security design document -- it has moved to the wiki, and simplify the readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 6 insertions, 20 deletions
@@ -2,27 +2,13 @@ [](https://travis-ci.org/micahflee/onionshare) -OnionShare lets you securely and anonymously share files of any size. It works by starting a web server, making it accessible as a Tor onion 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 onion 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 onion 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 file-sharing service. You host the file on your own computer and use a Tor onion service to make it temporarily accessible over the internet. The other user just needs to use Tor Browser to download the file from you. -Features include: +**Check out [the wiki](https://github.com/micahflee/onionshare/wiki) for information about how OnionShare works, what its security properties are, and how to use it.** -* 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 -* 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 - -If you're interested in exactly what OnionShare does and does not protect against, read the [Security Design Document](/SECURITY.md). - - - - -## 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 download OnionShare from <https://onionshare.org/>.** You can set up your development environment to build OnionShare yourself by following [these instructions](/BUILD.md). + +- +- |