Add Droplr README

3 files changed, 21 insertions, 17 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`
diff --git a/plugins/droplr/droplr.plugin.zsh b/plugins/droplr/droplr.plugin.zsh
index a20ca9368..2a2ec227c 100644
--- a/plugins/droplr/droplr.plugin.zsh
+++ b/plugins/droplr/droplr.plugin.zsh
@@ -1,3 +1 @@
-#!/bin/zsh
-
-alias droplr=$ZSH/plugins/droplr/droplr.rb
\ No newline at end of file
+alias droplr=$ZSH/plugins/droplr/droplr.rb
diff --git a/plugins/droplr/droplr.rb b/plugins/droplr/droplr.rb
index 38751dfcb..00300198e 100755
--- a/plugins/droplr/droplr.rb
+++ b/plugins/droplr/droplr.rb
@@ -1,17 +1,4 @@
 #!/usr/bin/env ruby
-#
-# droplr
-# Fabio Fernandes | http://fabiofl.me
-#
-# Use Droplr from the comand line to upload files and shorten links.
-#
-# Examples:
-# 
-# droplr ./path/to/file/
-# droplr http://example.com
-#
-# This needs Droplr.app to be installed and loged in.
-# Also, Mac only.
 
 if ARGV[0].nil?
    puts "You need to specify a parameter."
@@ -22,4 +9,4 @@ if ARGV[0][%r{^http[|s]://}i]
 	`osascript -e 'tell app "Droplr" to shorten "#{ARGV[0]}"'`
 else
 	`open -ga /Applications/Droplr.app "#{ARGV[0]}"`
-end
\ No newline at end of file
+end