浏览代码

Add Droplr README

Marc Cornellà 8 年之前
父节点
当前提交
8648873887
共有 3 个文件被更改,包括 21 次插入17 次删除
  1. 19 0
      plugins/droplr/README.md
  2. 1 3
      plugins/droplr/droplr.plugin.zsh
  3. 1 14
      plugins/droplr/droplr.rb

+ 19 - 0
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`

+ 1 - 3
plugins/droplr/droplr.plugin.zsh

@@ -1,3 +1 @@
-#!/bin/zsh
-
-alias droplr=$ZSH/plugins/droplr/droplr.rb
+alias droplr=$ZSH/plugins/droplr/droplr.rb

+ 1 - 14
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
+end