aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFreddy Martinez <freddy@freedom.press>2018-01-14 18:45:18 -0800
committerFreddy Martinez <freddy@freedom.press>2018-01-14 19:06:58 -0800
commit97a077854a2cda0097c7518fee13d95a9efbc754 (patch)
tree25d641ea244284349df6907f33a28b1e9d844fcc /README.md
parent58f4e7e756395fec4cf5d162b929a62053d8bfbe (diff)
downloadonionshare-97a077854a2cda0097c7518fee13d95a9efbc754.tar.gz
onionshare-97a077854a2cda0097c7518fee13d95a9efbc754.zip
this commit cleans up the README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index ad1263eb..c83636b0 100644
--- a/README.md
+++ b/README.md
@@ -2,13 +2,21 @@
[![Build Status](https://travis-ci.org/micahflee/onionshare.png)](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 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.
+[OnionShare](https://onionshare.org) 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 does _not_ require setting up a separate server or using a third party file-sharing service. You host the files on your own computer and use a Tor Onion Service to make it temporarily accessible over the internet. The receiving user just needs to open the URL in Tor Browser to download the file.
-**To learn how OnionShare works, what its security properties are, and how to use it, check out the [wiki](https://github.com/micahflee/onionshare/wiki).**
+## Documentation
-**You can download OnionShare for Windows and macOS from <https://onionshare.org/>. It should be available in your package manager for Linux, and it's included by default in Tails.**
+To learn how OnionShare works, what its security properties are, and how to use it, check out the [wiki](https://github.com/micahflee/onionshare/wiki).
+
+## Downloading Onionshare
+
+You can download OnionShare for Windows and macOS from the [OnionShare website](https://onionshare.org). It should be available in your package manager for Linux, and it's included by default in [Tails](https://tails.boum.org).
+
+## Developing OnionShare
You can set up your development environment to build OnionShare yourself by following [these instructions](/BUILD.md).
+# Screenshots
+
![Server Screenshot](/screenshots/server.png)
![Client Screenshot](/screenshots/client.png)