Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
catsby committed Jan 28, 2011
1 parent 2a71d1e commit 9caa91b
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 19 deletions.
30 changes: 30 additions & 0 deletions README.md
@@ -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/
19 changes: 0 additions & 19 deletions README.rdoc

This file was deleted.

0 comments on commit 9caa91b

Please sign in to comment.