Permalink
Browse files

Update README

  • Loading branch information...
catsby committed Jan 28, 2011
1 parent 5b4bff2 commit 63a39c052feec4e8f6f9bbd8f3bb5f3a2162e37f
Showing with 30 additions and 19 deletions.
  1. +30 −0 README.md
  2. +0 −19 README.rdoc
@@ -0,0 +1,30 @@
#Growl-Transfer

Growl-Transfer is a little gem that wraps around a file transfer protocol (scp/curl) and notifies you via growl when the transfer is complete.

##Installation
Growl-Transfer requires [Growl][1] to be installed first.

gem install growl-transfer

Then, in Growl's preferences, enable "Listen for incoming notifications" and "Allow remote application registration".
Growl-Transfer sends growl notifications to "localhost" and needs these options enabled to function. (Password support coming...'soon')

!["Growl Preferences"](http://ctshryock.com/static/images/growl-transfer-prefs.png)

##Contributing to Growl-Transfer

* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

##Copyright

Copyright (c) 2011 Clint Shryock. See LICENSE.txt for
further details.

[1]: http://growl.info/

This file was deleted.

Oops, something went wrong.

0 comments on commit 63a39c0

Please sign in to comment.