Permalink
Browse files

Added README

  • Loading branch information...
1 parent e44b897 commit a917943b392c8c54bba6376f6cef7defcff18cec @mdarby committed Feb 12, 2009
Showing with 31 additions and 15 deletions.
  1. +0 −13 README
  2. +29 −0 README.textile
  3. +2 −2 mq.gemspec
View
@@ -1,13 +0,0 @@
-Mq
-==
-
-Introduction goes here.
-
-
-Example
-=======
-
-Example goes here.
-
-
-Copyright (c) 2009 [name of plugin creator], released under the MIT license
View
@@ -0,0 +1,29 @@
+h2. mq
+
+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.
+
+h3. Requirements
+
+An existing Mailer
+
+h3. How to Install
+
+<pre>sudo gem install mdarby-mq</pre>
+
+h3. How to Use
+
+<pre>./script/generate mq EmailModelName MailerModelName</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. 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
View
@@ -1,6 +1,6 @@
Gem::Specification.new do |s|
s.name = "mq"
- s.version = "0.1"
+ s.version = "0.1.1"
s.date = "2009-02-11"
s.summary = "An email queue that actually works"
s.email = "matt@matt-darby.com"
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
s.authors = ["Matt Darby"]
s.files = [
"MIT-LICENSE",
- "README",
+ "README.textile",
"Rakefile",
"generators/mq/mq_generator.rb",
"generators/mq/templates/create_email_table.rb",

0 comments on commit a917943

Please sign in to comment.