Permalink
Browse files

README textile => markdown

  • Loading branch information...
1 parent 0480fe7 commit 884b28cf887a9a087bbcc199cc45fc42952f8f95 @mdarby committed Dec 17, 2009
Showing with 49 additions and 72 deletions.
  1. +49 −0 README.markdown
  2. +0 −18 README.rdoc
  3. +0 −54 README.textile
View
@@ -0,0 +1,49 @@
+#mq
+
+A Rails gem that generates an MVC stack that does email queuing
+
+What it does
+------------
+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.
+
+###Requirements
+
+None.
+
+###How to Install
+<pre><code>sudo gem install mq -s http://gemcutter.com</code></pre>
+
+###How to Use
+
+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><code>./script/generate mq Email Notifier</code></pre>
+
+mq requires your Mailer methods accept an email address as its first parameter, so a Mailer method should look like:
+<pre><code>Notifier.send_email_method(email_address)</code></pre>
+
+Of course, you can pass as many parameters as you'd like:
+<pre><code>Notifier.send_email_method(email_address, some_object, some_other_object, ...)</code></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><code>Email.queue(:send_email_method, "matt@matt-darby.com")</code></pre>
+
+You can pass multiple email addresses to the `Email.queue` method and mq will automatically generate individual emails for the recipients.
+<pre><code>Email.queue(:send_email_method, ["matt@matt-darby.com", "foo@bar.com"], ...)</code></pre>
+
+###Delivery of queued email
+
+You can create a cronjob (this on runs every five minutes)
+<pre><code>*/5 * * * * cd /path/to/your/app && ./script/runner/Email.deliver_all</code></pre>
+
+###How to Test
+
+Complete Rspec specs are included automatically. Well, complete aside from view specs as you'll just change the damned things anyway.
+
+About the Author
+----------------
+My name is [Matt Darby.](http://blog.matt-darby.com) I’m an IT Manager and pro-web-dev at for [Dynamix Engineering](http://dynamix-ltd.com) and hold a Master’s Degree in Computer Science from [Franklin University](http://www.franklin.edu) in sunny [Columbus, OH.](http://en.wikipedia.org/wiki/Columbus,_Ohio)
+
+Feel free to check out my [site](http://matt-darby.com) or [recommend me](http://www.workingwithrails.com/person/10908-matt-darby)
View
@@ -1,18 +0,0 @@
-= mq
-
-Description goes here.
-
-== Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
- future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
- (if you want to have your own version, that is fine but
- bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2009 Matt Darby. See LICENSE for details.
View
@@ -1,54 +0,0 @@
-h2. mq
-
-A Rails gem that generates an MVC stack that does email queuing
-
-h3. What it does
-
-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
-
-None.
-
-h3. How to Install
-
-<pre>sudo gem install mq -s http://gemcutter.com</pre>
-
-h3. How to Use
-
-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

0 comments on commit 884b28c

Please sign in to comment.