aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2020-08-27 18:14:20 -0400
committerMicah Lee <micah@micahflee.com>2020-08-27 18:14:20 -0400
commitdc6cefd7ce0d732667163273871a0b93ce62ea3b (patch)
treea261e06b2b92fd78c73444436ce2562852bd6273 /README.md
parent9cddab71e926d8f3075bb52302f63f62c1362eb5 (diff)
downloadonionshare-dc6cefd7ce0d732667163273871a0b93ce62ea3b.tar.gz
onionshare-dc6cefd7ce0d732667163273871a0b93ce62ea3b.zip
Update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/README.md b/README.md
index 45ab3d55..57a835be 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,24 @@
# OnionShare
-OnionShare is an open source tool that lets you securely and anonymously share files, host websites, and chat with friends using the Tor network. To install OnionShare and to learn how it works and how to use it, check out its website at https://onionshare.org.
+OnionShare is an open source tool that lets you securely and anonymously share files, host websites, and chat with friends using the Tor network.
+
+## Installing OnionShare
+
+You can download OnionShare for Windows and macOS from the [OnionShare website](https://onionshare.org).
+
+For macOS you can also use [Homebrew](https://brew.sh/):
+
+```
+brew cask install onionshare
+```
+
+See [these instructions](https://docs.onionshare.org/en/install.html#install-in-linux-with-flatpak) to install OnionShare in Linux with Flatpak.
+
+## Documentation
+
+To learn how OnionShare works, what its security properties are, how to use it, and how to contribute to the project, check out https://docs.onionshare.org.
+
+---
Test status: [![CircleCI](https://circleci.com/gh/micahflee/onionshare.svg?style=svg)](https://circleci.com/gh/micahflee/onionshare)