mirror of
https://github.com/onionshare/onionshare.git
synced 2025-02-11 04:09:08 -05:00
Update readme to include repology badge and better install instructions, and also new screenshots
This commit is contained in:
parent
f7d9660a0c
commit
192792ecc2
28
README.md
28
README.md
@ -1,22 +1,38 @@
|
|||||||
# OnionShare
|
# 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.
|
[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
|
## 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).
|
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). It should be available in your package manager for Linux, and it's included by default in [Tails](https://tails.boum.org).
|
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:
|
||||||
|
|
||||||
|
[![Packaging status](https://repology.org/badge/vertical-allrepos/onionshare.svg)](https://repology.org/metapackage/onionshare/versions)
|
||||||
|
|
||||||
## Developing OnionShare
|
## 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).
|
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).
|
||||||
|
|
||||||
|
Test status: [![CircleCI](https://circleci.com/gh/micahflee/onionshare.svg?style=svg)](https://circleci.com/gh/micahflee/onionshare)
|
||||||
|
|
||||||
# Screenshots
|
# Screenshots
|
||||||
|
|
||||||
![Server Screenshot](/screenshots/appdata-server.png)
|
![Share mode OnionShare](/screenshots/onionshare-share-server.png)
|
||||||
![Client Screenshot](/screenshots/client.png)
|
|
||||||
|
![Share mode Tor Browser](/screenshots/onionshare-share-client.png)
|
||||||
|
|
||||||
|
![Receive mode OnionShare](/screenshots/onionshare-receive-server.png)
|
||||||
|
|
||||||
|
![Receive mode Tor Browser](/screenshots/onionshare-receive-client.png)
|
||||||
|
Binary file not shown.
Before Width: | Height: | Size: 40 KiB |
BIN
screenshots/onionshare-receive-client.png
Normal file
BIN
screenshots/onionshare-receive-client.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 58 KiB |
BIN
screenshots/onionshare-receive-server.png
Normal file
BIN
screenshots/onionshare-receive-server.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 66 KiB |
BIN
screenshots/onionshare-share-client.png
Normal file
BIN
screenshots/onionshare-share-client.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 41 KiB |
BIN
screenshots/onionshare-share-server.png
Normal file
BIN
screenshots/onionshare-share-server.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 54 KiB |
Loading…
x
Reference in New Issue
Block a user