summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiguel Jacq <mig@mig5.net>2018-11-26 10:37:04 +1100
committerGitHub <noreply@github.com>2018-11-26 10:37:04 +1100
commit2ca4f56de1fec536562b4652e6e862bb56858106 (patch)
tree15197122bb7aadaab6273179bc35d8aee020a8bb
parentb2a98fb5e71ab042d377bee8754c0b78adfed66a (diff)
parent87d10e196315ce8e0e1cf30307fefac8d5f9df57 (diff)
downloadonionshare-2ca4f56de1fec536562b4652e6e862bb56858106.tar.gz
onionshare-2ca4f56de1fec536562b4652e6e862bb56858106.zip
Merge pull request #822 from micahflee/819_update_readme
Include repology badge, and new screenshots
-rw-r--r--README.md30
-rw-r--r--screenshots/client.pngbin40602 -> 0 bytes
-rw-r--r--screenshots/onionshare-receive-client.pngbin0 -> 59463 bytes
-rw-r--r--screenshots/onionshare-receive-server.pngbin0 -> 68038 bytes
-rw-r--r--screenshots/onionshare-share-client.pngbin0 -> 42423 bytes
-rw-r--r--screenshots/onionshare-share-server.pngbin0 -> 55027 bytes
6 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)
diff --git a/screenshots/client.png b/screenshots/client.png
deleted file mode 100644
index fdf69fd0..00000000
--- a/screenshots/client.png
+++ /dev/null
Binary files differ
diff --git a/screenshots/onionshare-receive-client.png b/screenshots/onionshare-receive-client.png
new file mode 100644
index 00000000..7702a4bd
--- /dev/null
+++ b/screenshots/onionshare-receive-client.png
Binary files differ
diff --git a/screenshots/onionshare-receive-server.png b/screenshots/onionshare-receive-server.png
new file mode 100644
index 00000000..0962a74f
--- /dev/null
+++ b/screenshots/onionshare-receive-server.png
Binary files differ
diff --git a/screenshots/onionshare-share-client.png b/screenshots/onionshare-share-client.png
new file mode 100644
index 00000000..7cb6c3c8
--- /dev/null
+++ b/screenshots/onionshare-share-client.png
Binary files differ
diff --git a/screenshots/onionshare-share-server.png b/screenshots/onionshare-share-server.png
new file mode 100644
index 00000000..76830876
--- /dev/null
+++ b/screenshots/onionshare-share-server.png
Binary files differ