README.textile in mdarby-mq-0.1.1 vs README.textile in mdarby-mq-0.1.2
- old
+ new
@@ -2,28 +2,53 @@
A Rails gem that generates an MVC stack that does email queuing
h3. What it does
-I got tire of crappy attempts at queuing emails, so I wrote my own. mq is a generator that generates an MVC stack for queuing emails. It has a UI too.
+mq is a generator that generates an MVC stack for queuing emails. It has a UI too.
+I got tired of dealing with crappy email queuing systems in Rails, so I wrote my own.
h3. Requirements
-An existing Mailer
+None.
h3. How to Install
-<pre>sudo gem install mdarby-mq</pre>
+<pre>sudo gem install mdarby-mq -s http://gems.github.com</pre>
h3. How to Use
-<pre>./script/generate mq EmailModelName MailerModelName</pre>
+Assuming you'd like to name your mq table @Email@, and your Mailer model is named @Notifier@
+Generate the files necessary for your app:
+<pre>./script/generate mq Email Notifier</pre>
+
+mq requires your Mailer methods accept an email address as its first parameter, so a Mailer method should look like:
+<pre>Notifier.send_email_method(email_address)</pre>
+
+Of course, you can pass as many parameters as you'd like:
+<pre>Notifier.send_email_method(email_address, some_object, some_other_object, ...)</pre>
+
+Queue an email by calling @Email.queue@ with the name of your Notifier method as the first parameter, and the recipient email address as the second parameter, followed by anything else you'd like to pass.
+<pre>Email.queue(:send_email_method, "matt@matt-darby.com")</pre>
+
+You can pass multiple email addresses to the @Email.queue@ method and mq will automatically generate individual emails for the recipients.
+<pre>Email.queue(:send_email_method, ["matt@matt-darby.com", "foo@bar.com"], ...)</pre>
+
+h3. Delivery of queued email
+
+You can create a cronjob (this on runs every five minutes)
+<pre>*/5 * * * * cd /path/to/your/app && ./script/runner/Email.deliver_all</pre>
+
h3. How to Test
Complete Rspec specs are included automatically. Well, complete aside from view specs as you'll just change the damned things anyway.
+h3. Help
+
+Add a ticket to "MQ's Lighthouse Account":http://mdarby.lighthouseapp.com/projects/28699-mq/overview
+
h3. About the Author
My name is Matt Darby. I'm the Lead Web Developer and IT Manager at "Dynamix Engineering":http://dynamix-ltd.com and hold a Master's Degree in Computer Science from "Franklin University":http://franklin.edu in Columbus, OH.
-Feel free to check out my "blog":http://blog.matt-darby.com or to "recommend me":http://www.workingwithrails.com/recommendation/new/person/10908-matt-darby
\ No newline at end of file
+Feel free to check out my "blog":http://blog.matt-darby.com or to "recommend me":http://www.workingwithrails.com/recommendation/new/person/10908-matt-darby