aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..692830e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+Copy Mailto
+===========
+
+A `mailto:` link handler that allows you to copy the email address to the
+clipboard.
+
+![screenshot.png](Screenshot)
+
+
+## Usage
+Once the application has been registered as the default app for `mailto:` links,
+it will open whenever one is clicked.
+
+The following keyboard shortcuts are available in the app:
+
+| Shortcut | Action |
+|---------------------|-----------------------------|
+| **q** or **Escape** | Quit |
+| **Enter** | Copy email address and quit |
+
+To set Copy Mailto as the default handler for `mailto:` URLs, run:
+
+ $ /Applications/Copy\ Mailto.app/Contents/MacOS/Copy\ Mailto --set-url-handler
+
+
+## Install
+Download the app from the [releases][1] page. Unzip it and drag it to the
+`Applications` folder.
+
+
+## License
+Copyright © 2018 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
+COPYING file).
+
+
+[1]: https://github.com/teddywing/Copy-Mailto/releases