Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

converted readme from rdoc to md

  • Loading branch information...
commit 529e6442971db55c0e4c2017fbdd2bbadd764a41 1 parent d965353
@dgeb dgeb authored
Showing with 37 additions and 22 deletions.
  1. +36 −21 README.rdoc → README.md
  2. +1 −1  delayed_mailhopper.gemspec
View
57 README.rdoc → README.md
@@ -1,62 +1,77 @@
-= DelayedMailhopper
+# DelayedMailhopper
DelayedMailhopper provides a simple solution to queue, deliver and archive emails in Rails apps. It extends Mailhopper and uses DelayedJob to queue delivery jobs asynchronously.
-== Requirements
+## Requirements
-* Rails 3.1+
-* DelayedJob
-* Mailhopper
+ * Rails 3.1+
+ * DelayedJob
+ * Mailhopper
-== Installation
+## Installation
Add to your project's Gemfile:
- gem 'delayed_mailhopper'
+```
+gem 'delayed_mailhopper'
+```
Install with bundler (note: also installs dependencies such as DelayedJob and Mailhopper):
- bundle install
+```
+bundle install
+```
-== Configure Mailhopper
+## Configure Mailhopper
If you haven't already, you'll need to run generators for Mailhopper and then migrate your database.
- rails g mailhopper
- rake db:migrate
+```
+rails g mailhopper
+rake db:migrate
+```
-== Configure DelayedJob
-=== ActiveRecord Backend
+## Configure DelayedJob
+
+### ActiveRecord Backend
Add the gem to your Gemfile:
- gem 'delayed_job_active_record'
+```
+gem 'delayed_job_active_record'
+```
Run the generator to create the migration for the delayed_job table.
- rails g delayed_job:active_record
- rake db:migrate
+```
+rails g delayed_job:active_record
+rake db:migrate
+```
see the README: https://github.com/collectiveidea/delayed_job_active_record
-=== Mongoid backend
+### Mongoid backend
Add the gem to your Gemfile:
- gem 'delayed_job_mongoid'
+```
+gem 'delayed_job_mongoid'
+```
Create the indexes (and don't forget to do this on your production database):
- script/rails runner 'Delayed::Backend::Mongoid::Job.create_indexes'
+```
+script/rails runner 'Delayed::Backend::Mongoid::Job.create_indexes'
+```
see the README: https://github.com/collectiveidea/delayed_job_mongoid
-== References
+## References
Please see the README for Mailhopper: https://github.com/cerebris/mailhopper
And for DelayedJob: https://github.com/collectiveidea/delayed_job/
-== Copyright
+## Copyright
Copyright (c) 2011 Cerebris Corporation. This is free software released under the MIT License (see MIT-LICENSE for details).
View
2  delayed_mailhopper.gemspec
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
s.summary = "A simple solution that uses ActiveRecord and DelayedJob to queue, deliver and archive emails in Rails apps."
s.description = "DelayedMailhopper extends Mailhopper to deliver emails asynchronously with DelayedJob."
- s.files = Dir["{app,config,db,lib}/**/*"] + ["MIT-LICENSE", "Rakefile", "README.rdoc"]
+ s.files = Dir["{app,config,db,lib}/**/*"] + ["MIT-LICENSE", "Rakefile", "README.md"]
s.test_files = Dir["test/**/*"]
s.add_dependency "mailhopper", "~> 0.0.1"

0 comments on commit 529e644

Please sign in to comment.
Something went wrong with that request. Please try again.