From 56e755a5b0c9e9280987dc270d43e734f36b3085 Mon Sep 17 00:00:00 2001
From: Guillaume Dott <guillaume+github@dott.fr>
Date: Tue, 26 May 2015 15:12:39 +0200
Subject: [PATCH] Write README

---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 43 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 4846440..2bfd637 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Capistrano::Send
 
-TODO: Write a gem description
+This gem provides some notifiers to send notifications after a deploy with Capistrano.
 
 ## Installation
 
@@ -14,18 +14,49 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install capistrano-send
-
 ## Usage
 
-TODO: Write usage instructions here
+Add this line to your `Capfile` to use all notifiers:
+```ruby
+require 'capistrano/send/all'
+```
 
-## Contributing
+### Email
 
-1. Fork it ( https://github.com/[my-github-username]/capistrano-send/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+The `mail` notifier sends an email with some useful informations about the release.
+
+Add this line to your `Capfile`:
+```ruby
+require 'capistrano/send/mail'
+```
+
+You must configure the `From` and `To` fields and can configure the delivery method in your `config/deploy.rb`:
+```ruby
+set :send_mail, to: 'to@example.org', from: 'from@example.org',
+  via: :smtp, via_options: {address: 'smtp.example.org'}
+```
+This notifier uses the [mail](https://github.com/mikel/mail) gem to send emails. Read its documentation for more delivery methods.
+
+### Libnotify
+
+The `libnotify` notifier uses `libnotify` to display a notification on your computer.
+
+To use it, add the [libnotify](https://rubygems.org/gems/libnotify) gem to your Gemfile:
+```ruby
+gem 'libnotify'
+```
+
+Then add this line to your `Capfile`:
+```ruby
+require 'capistrano/send/libnotify'
+```
+
+### Notify-send
+
+The `notify-send` notifier displays a notification on your computer like `libnotify`
+but does not require the dependency and uses the `notify-send` binary.
+
+Add this line to your `Capfile`:
+```ruby
+require 'capistrano/send/notify-send'
+```