From f30cb02588a39b38e3d84eebb3b7b734810b7d54 Mon Sep 17 00:00:00 2001
From: Micah Lee <micah@micahflee.com>
Date: Tue, 30 Jun 2020 15:13:47 -0700
Subject: Add snap readme

---
 snap/README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 snap/README.md

(limited to 'snap')

diff --git a/snap/README.md b/snap/README.md
new file mode 100644
index 00000000..54f80476
--- /dev/null
+++ b/snap/README.md
@@ -0,0 +1,28 @@
+# Snap package
+
+This folder contains files to build a [snap package](https://snapcraft.io/). First make sure you install `snap` and `snapcraft` (`snap install snapcraft --classic`).
+
+To build the snap, cd to the `snap` folder and run:
+
+```sh
+snapcraft
+```
+
+See your installed snaps:
+
+```sh
+snap list
+```
+
+Run the OnionShare snap:
+
+```sh
+/snap/bin/onionshare      # CLI version
+/snap/bin/onionshare-gui  # GUI version
+```
+
+Delete the OnionShare snap:
+
+```sh
+snap remove onionshare
+```
-- 
cgit v1.2.3-54-g00ecf