aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2018-11-25 13:48:50 -0800
committerMicah Lee <micah@micahflee.com>2018-11-25 13:48:50 -0800
commit24a4e1567a4089982045079927cf4c114e0bc285 (patch)
tree319c9a4e6a391887a6d65f67f2453e177a8f584e /README.md
parent1690d76601e16fb5b5c5c736e85658a31b60513d (diff)
downloadonionshare-24a4e1567a4089982045079927cf4c114e0bc285.tar.gz
onionshare-24a4e1567a4089982045079927cf4c114e0bc285.zip
Update readme to include repology badge and better install instructions, and also new screenshots
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 23 insertions, 7 deletions
diff --git a/README.md b/README.md
index a4ec2a87..caa4cb62 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,38 @@
# OnionShare
-[![CircleCI](https://circleci.com/gh/micahflee/onionshare.svg?style=svg)](https://circleci.com/gh/micahflee/onionshare)
-
[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.
## Documentation
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
+## Downloading OnionShare
+
+You can download OnionShare for Windows and macOS from the [OnionShare website](https://onionshare.org).
+
+For Ubuntu-like distributions, you could use this PPA to get the latest version:
+
+```
+sudo add-apt-repository ppa:micahflee/ppa
+sudo apt install -y onionshare
+```
+
+OnionShare also may be available in your operating system's package manager:
-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).
+[![Packaging status](https://repology.org/badge/vertical-allrepos/onionshare.svg)](https://repology.org/metapackage/onionshare/versions)
## Developing OnionShare
You can set up your development environment to build OnionShare yourself by following [these instructions](/BUILD.md). You may also subscribe to our developers mailing list [here](https://lists.riseup.net/www/info/onionshare-dev).
-# Screenshots
+Test status: [![CircleCI](https://circleci.com/gh/micahflee/onionshare.svg?style=svg)](https://circleci.com/gh/micahflee/onionshare)
+
+# Screenshots
+
+![Share mode OnionShare](/screenshots/onionshare-share-server.png)
+
+![Share mode Tor Browser](/screenshots/onionshare-share-client.png)
+
+![Receive mode OnionShare](/screenshots/onionshare-receive-server.png)
-![Server Screenshot](/screenshots/appdata-server.png)
-![Client Screenshot](/screenshots/client.png)
+![Receive mode Tor Browser](/screenshots/onionshare-receive-client.png)