summaryrefslogtreecommitdiff
path: root/plugins/droplr/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2016-09-02 20:25:28 +0200
committerMarc Cornellà <marc.cornella@live.com>2016-09-02 20:26:14 +0200
commit864887388758b615d15a3f30a461aff1a7711d0b (patch)
treefcf8825a4ab47a36482923bfa5de86d7baccdad1 /plugins/droplr/README.md
parent1af4e9c521d82068871956dc4cf172a262827520 (diff)
downloadzsh-864887388758b615d15a3f30a461aff1a7711d0b.tar.gz
zsh-864887388758b615d15a3f30a461aff1a7711d0b.tar.bz2
zsh-864887388758b615d15a3f30a461aff1a7711d0b.zip
Add Droplr README
Diffstat (limited to 'plugins/droplr/README.md')
-rw-r--r--plugins/droplr/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/plugins/droplr/README.md b/plugins/droplr/README.md
new file mode 100644
index 000000000..cfbec25ed
--- /dev/null
+++ b/plugins/droplr/README.md
@@ -0,0 +1,19 @@
+# droplr
+
+Use [Droplr](https://droplr.com/) from the comand line to upload files and shorten
+links. It needs to have [Droplr.app](https://droplr.com/apps) installed and logged
+in. MacOS only.
+
+To use it, add `droplr` to the `$plugins` variable in your zshrc file:
+
+```zsh
+plugins=(... droplr)
+```
+
+Author: [Fabio Fernandes](https://github.com/fabiofl)
+
+## Examples
+
+- Upload a file: `droplr ./path/to/file/`
+
+- Shorten a link: `droplr http://example.com`